LiveTvService.cs 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937
  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. [ApiMember(Name = "AddCurrentProgram", Description = "Optional. Adds current program info to each channel", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  69. public bool AddCurrentProgram { get; set; }
  70. public GetChannels()
  71. {
  72. AddCurrentProgram = true;
  73. }
  74. }
  75. [Route("/LiveTv/Channels/{Id}", "GET", Summary = "Gets a live tv channel")]
  76. [Authenticated]
  77. public class GetChannel : IReturn<ChannelInfoDto>
  78. {
  79. /// <summary>
  80. /// Gets or sets the id.
  81. /// </summary>
  82. /// <value>The id.</value>
  83. [ApiMember(Name = "Id", Description = "Channel Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  84. public string Id { get; set; }
  85. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  86. public string UserId { get; set; }
  87. }
  88. [Route("/LiveTv/Recordings", "GET", Summary = "Gets live tv recordings")]
  89. [Authenticated]
  90. public class GetRecordings : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
  91. {
  92. [ApiMember(Name = "ChannelId", Description = "Optional filter by channel id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  93. public string ChannelId { get; set; }
  94. [ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  95. public string UserId { get; set; }
  96. [ApiMember(Name = "GroupId", Description = "Optional filter by recording group.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  97. public string GroupId { get; set; }
  98. [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")]
  99. public int? StartIndex { get; set; }
  100. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  101. public int? Limit { get; set; }
  102. [ApiMember(Name = "Status", Description = "Optional filter by recording status.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  103. public RecordingStatus? Status { get; set; }
  104. [ApiMember(Name = "Status", Description = "Optional filter by recordings that are in progress, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  105. public bool? IsInProgress { get; set; }
  106. [ApiMember(Name = "SeriesTimerId", Description = "Optional filter by recordings belonging to a series timer", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  107. public string SeriesTimerId { get; set; }
  108. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  109. public bool? EnableImages { get; set; }
  110. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  111. public int? ImageTypeLimit { get; set; }
  112. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  113. public string EnableImageTypes { get; set; }
  114. /// <summary>
  115. /// Fields to return within the items, in addition to basic information
  116. /// </summary>
  117. /// <value>The fields.</value>
  118. [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)]
  119. public string Fields { get; set; }
  120. }
  121. [Route("/LiveTv/Recordings/Groups", "GET", Summary = "Gets live tv recording groups")]
  122. [Authenticated]
  123. public class GetRecordingGroups : IReturn<QueryResult<BaseItemDto>>
  124. {
  125. [ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  126. public string UserId { get; set; }
  127. }
  128. [Route("/LiveTv/Recordings/{Id}", "GET", Summary = "Gets a live tv recording")]
  129. [Authenticated]
  130. public class GetRecording : IReturn<BaseItemDto>
  131. {
  132. [ApiMember(Name = "Id", Description = "Recording Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  133. public string Id { get; set; }
  134. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  135. public string UserId { get; set; }
  136. }
  137. [Route("/LiveTv/Tuners/{Id}/Reset", "POST", Summary = "Resets a tv tuner")]
  138. [Authenticated]
  139. public class ResetTuner : IReturnVoid
  140. {
  141. [ApiMember(Name = "Id", Description = "Tuner Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  142. public string Id { get; set; }
  143. }
  144. [Route("/LiveTv/Timers/{Id}", "GET", Summary = "Gets a live tv timer")]
  145. [Authenticated]
  146. public class GetTimer : IReturn<TimerInfoDto>
  147. {
  148. [ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  149. public string Id { get; set; }
  150. }
  151. [Route("/LiveTv/Timers/Defaults", "GET", Summary = "Gets default values for a new timer")]
  152. [Authenticated]
  153. public class GetDefaultTimer : IReturn<SeriesTimerInfoDto>
  154. {
  155. [ApiMember(Name = "ProgramId", Description = "Optional, to attach default values based on a program.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  156. public string ProgramId { get; set; }
  157. }
  158. [Route("/LiveTv/Timers", "GET", Summary = "Gets live tv timers")]
  159. [Authenticated]
  160. public class GetTimers : IReturn<QueryResult<TimerInfoDto>>
  161. {
  162. [ApiMember(Name = "ChannelId", Description = "Optional filter by channel id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  163. public string ChannelId { get; set; }
  164. [ApiMember(Name = "SeriesTimerId", Description = "Optional filter by timers belonging to a series timer", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  165. public string SeriesTimerId { get; set; }
  166. }
  167. [Route("/LiveTv/Programs", "GET,POST", Summary = "Gets available live tv epgs..")]
  168. [Authenticated]
  169. public class GetPrograms : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
  170. {
  171. [ApiMember(Name = "ChannelIds", Description = "The channels to return guide information for.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  172. public string ChannelIds { get; set; }
  173. [ApiMember(Name = "UserId", Description = "Optional filter by user id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  174. public string UserId { get; set; }
  175. [ApiMember(Name = "MinStartDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  176. public string MinStartDate { get; set; }
  177. [ApiMember(Name = "HasAired", Description = "Optional. Filter by programs that have completed airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  178. public bool? HasAired { get; set; }
  179. [ApiMember(Name = "MaxStartDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  180. public string MaxStartDate { get; set; }
  181. [ApiMember(Name = "MinEndDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  182. public string MinEndDate { get; set; }
  183. [ApiMember(Name = "MaxEndDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  184. public string MaxEndDate { get; set; }
  185. [ApiMember(Name = "IsMovie", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  186. public bool? IsMovie { get; set; }
  187. [ApiMember(Name = "IsKids", Description = "Optional filter for kids.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  188. public bool? IsKids { get; set; }
  189. [ApiMember(Name = "IsSports", Description = "Optional filter for sports.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  190. public bool? IsSports { get; set; }
  191. [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")]
  192. public int? StartIndex { get; set; }
  193. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  194. public int? Limit { get; set; }
  195. [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)]
  196. public string SortBy { get; set; }
  197. [ApiMember(Name = "SortOrder", Description = "Sort Order - Ascending,Descending", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  198. public SortOrder? SortOrder { get; set; }
  199. [ApiMember(Name = "Genres", Description = "The genres to return guide information for.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  200. public string Genres { get; set; }
  201. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  202. public bool? EnableImages { get; set; }
  203. public bool EnableTotalRecordCount { get; set; }
  204. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  205. public int? ImageTypeLimit { get; set; }
  206. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  207. public string EnableImageTypes { get; set; }
  208. /// <summary>
  209. /// Fields to return within the items, in addition to basic information
  210. /// </summary>
  211. /// <value>The fields.</value>
  212. [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)]
  213. public string Fields { get; set; }
  214. public GetPrograms()
  215. {
  216. EnableTotalRecordCount = true;
  217. }
  218. }
  219. [Route("/LiveTv/Programs/Recommended", "GET", Summary = "Gets available live tv epgs..")]
  220. [Authenticated]
  221. public class GetRecommendedPrograms : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
  222. {
  223. public bool EnableTotalRecordCount { get; set; }
  224. public GetRecommendedPrograms()
  225. {
  226. EnableTotalRecordCount = true;
  227. }
  228. [ApiMember(Name = "UserId", Description = "Optional filter by user id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  229. public string UserId { get; set; }
  230. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  231. public int? Limit { get; set; }
  232. [ApiMember(Name = "IsAiring", Description = "Optional. Filter by programs that are currently airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  233. public bool? IsAiring { get; set; }
  234. [ApiMember(Name = "HasAired", Description = "Optional. Filter by programs that have completed airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  235. public bool? HasAired { get; set; }
  236. [ApiMember(Name = "IsSports", Description = "Optional filter for sports.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  237. public bool? IsSports { get; set; }
  238. [ApiMember(Name = "IsMovie", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  239. public bool? IsMovie { get; set; }
  240. [ApiMember(Name = "IsKids", Description = "Optional filter for kids.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  241. public bool? IsKids { get; set; }
  242. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  243. public bool? EnableImages { get; set; }
  244. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  245. public int? ImageTypeLimit { get; set; }
  246. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  247. public string EnableImageTypes { get; set; }
  248. /// <summary>
  249. /// Fields to return within the items, in addition to basic information
  250. /// </summary>
  251. /// <value>The fields.</value>
  252. [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)]
  253. public string Fields { get; set; }
  254. }
  255. [Route("/LiveTv/Programs/{Id}", "GET", Summary = "Gets a live tv program")]
  256. [Authenticated]
  257. public class GetProgram : IReturn<BaseItemDto>
  258. {
  259. [ApiMember(Name = "Id", Description = "Program Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  260. public string Id { get; set; }
  261. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  262. public string UserId { get; set; }
  263. }
  264. [Route("/LiveTv/Recordings/{Id}", "DELETE", Summary = "Deletes a live tv recording")]
  265. [Authenticated]
  266. public class DeleteRecording : IReturnVoid
  267. {
  268. [ApiMember(Name = "Id", Description = "Recording Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  269. public string Id { get; set; }
  270. }
  271. [Route("/LiveTv/Timers/{Id}", "DELETE", Summary = "Cancels a live tv timer")]
  272. [Authenticated]
  273. public class CancelTimer : IReturnVoid
  274. {
  275. [ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  276. public string Id { get; set; }
  277. }
  278. [Route("/LiveTv/Timers/{Id}", "POST", Summary = "Updates a live tv timer")]
  279. [Authenticated]
  280. public class UpdateTimer : TimerInfoDto, IReturnVoid
  281. {
  282. }
  283. [Route("/LiveTv/Timers", "POST", Summary = "Creates a live tv timer")]
  284. [Authenticated]
  285. public class CreateTimer : TimerInfoDto, IReturnVoid
  286. {
  287. }
  288. [Route("/LiveTv/SeriesTimers/{Id}", "GET", Summary = "Gets a live tv series timer")]
  289. [Authenticated]
  290. public class GetSeriesTimer : IReturn<TimerInfoDto>
  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", "GET", Summary = "Gets live tv series timers")]
  296. [Authenticated]
  297. public class GetSeriesTimers : IReturn<QueryResult<SeriesTimerInfoDto>>
  298. {
  299. [ApiMember(Name = "SortBy", Description = "Optional. Sort by SortName or Priority", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  300. public string SortBy { get; set; }
  301. [ApiMember(Name = "SortOrder", Description = "Optional. Sort in Ascending or Descending order", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  302. public SortOrder SortOrder { get; set; }
  303. }
  304. [Route("/LiveTv/SeriesTimers/{Id}", "DELETE", Summary = "Cancels a live tv series timer")]
  305. [Authenticated]
  306. public class CancelSeriesTimer : IReturnVoid
  307. {
  308. [ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  309. public string Id { get; set; }
  310. }
  311. [Route("/LiveTv/SeriesTimers/{Id}", "POST", Summary = "Updates a live tv series timer")]
  312. [Authenticated]
  313. public class UpdateSeriesTimer : SeriesTimerInfoDto, IReturnVoid
  314. {
  315. }
  316. [Route("/LiveTv/SeriesTimers", "POST", Summary = "Creates a live tv series timer")]
  317. [Authenticated]
  318. public class CreateSeriesTimer : SeriesTimerInfoDto, IReturnVoid
  319. {
  320. }
  321. [Route("/LiveTv/Recordings/Groups/{Id}", "GET", Summary = "Gets a recording group")]
  322. [Authenticated]
  323. public class GetRecordingGroup : IReturn<BaseItemDto>
  324. {
  325. [ApiMember(Name = "Id", Description = "Recording group Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  326. public string Id { get; set; }
  327. }
  328. [Route("/LiveTv/GuideInfo", "GET", Summary = "Gets guide info")]
  329. [Authenticated]
  330. public class GetGuideInfo : IReturn<GuideInfo>
  331. {
  332. }
  333. [Route("/LiveTv/Folder", "GET", Summary = "Gets the users live tv folder, along with configured images")]
  334. [Authenticated]
  335. public class GetLiveTvFolder : IReturn<BaseItemDto>
  336. {
  337. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  338. public string UserId { get; set; }
  339. }
  340. [Route("/LiveTv/TunerHosts", "POST", Summary = "Adds a tuner host")]
  341. [Authenticated]
  342. public class AddTunerHost : TunerHostInfo, IReturn<TunerHostInfo>
  343. {
  344. }
  345. [Route("/LiveTv/TunerHosts", "DELETE", Summary = "Deletes a tuner host")]
  346. [Authenticated]
  347. public class DeleteTunerHost : IReturnVoid
  348. {
  349. [ApiMember(Name = "Id", Description = "Tuner host id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "DELETE")]
  350. public string Id { get; set; }
  351. }
  352. [Route("/LiveTv/ListingProviders", "POST", Summary = "Adds a listing provider")]
  353. [Authenticated(AllowBeforeStartupWizard = true)]
  354. public class AddListingProvider : ListingsProviderInfo, IReturn<ListingsProviderInfo>
  355. {
  356. public bool ValidateLogin { get; set; }
  357. public bool ValidateListings { get; set; }
  358. }
  359. [Route("/LiveTv/ListingProviders", "DELETE", Summary = "Deletes a listing provider")]
  360. [Authenticated(AllowBeforeStartupWizard = true)]
  361. public class DeleteListingProvider : IReturnVoid
  362. {
  363. [ApiMember(Name = "Id", Description = "Provider id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "DELETE")]
  364. public string Id { get; set; }
  365. }
  366. [Route("/LiveTv/ListingProviders/Lineups", "GET", Summary = "Gets available lineups")]
  367. [Authenticated(AllowBeforeStartupWizard = true)]
  368. public class GetLineups : IReturn<List<NameIdPair>>
  369. {
  370. [ApiMember(Name = "Id", Description = "Provider id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  371. public string Id { get; set; }
  372. [ApiMember(Name = "Type", Description = "Provider Type", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  373. public string Type { get; set; }
  374. [ApiMember(Name = "Location", Description = "Location", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  375. public string Location { get; set; }
  376. [ApiMember(Name = "Country", Description = "Country", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  377. public string Country { get; set; }
  378. }
  379. [Route("/LiveTv/ListingProviders/SchedulesDirect/Countries", "GET", Summary = "Gets available lineups")]
  380. [Authenticated(AllowBeforeStartupWizard = true)]
  381. public class GetSchedulesDirectCountries
  382. {
  383. }
  384. [Route("/LiveTv/Registration", "GET")]
  385. [Authenticated]
  386. public class GetLiveTvRegistrationInfo : IReturn<MBRegistrationRecord>
  387. {
  388. [ApiMember(Name = "ChannelId", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  389. public string ChannelId { get; set; }
  390. [ApiMember(Name = "ProgramId", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  391. public string ProgramId { get; set; }
  392. [ApiMember(Name = "Feature", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  393. public string Feature { get; set; }
  394. }
  395. [Route("/LiveTv/TunerHosts/Satip/IniMappings", "GET", Summary = "Gets available mappings")]
  396. [Authenticated(AllowBeforeStartupWizard = true)]
  397. public class GetSatIniMappings : IReturn<List<NameValuePair>>
  398. {
  399. }
  400. [Route("/LiveTv/TunerHosts/Satip/ChannelScan", "GET", Summary = "Scans for available channels")]
  401. [Authenticated(AllowBeforeStartupWizard = true)]
  402. public class GetSatChannnelScanResult : TunerHostInfo
  403. {
  404. }
  405. public class LiveTvService : BaseApiService
  406. {
  407. private readonly ILiveTvManager _liveTvManager;
  408. private readonly IUserManager _userManager;
  409. private readonly IConfigurationManager _config;
  410. private readonly IHttpClient _httpClient;
  411. private readonly ILibraryManager _libraryManager;
  412. private readonly IDtoService _dtoService;
  413. public LiveTvService(ILiveTvManager liveTvManager, IUserManager userManager, IConfigurationManager config, IHttpClient httpClient, ILibraryManager libraryManager, IDtoService dtoService)
  414. {
  415. _liveTvManager = liveTvManager;
  416. _userManager = userManager;
  417. _config = config;
  418. _httpClient = httpClient;
  419. _libraryManager = libraryManager;
  420. _dtoService = dtoService;
  421. }
  422. public async Task<object> Get(GetSatChannnelScanResult request)
  423. {
  424. var result = await _liveTvManager.GetSatChannelScanResult(request, CancellationToken.None).ConfigureAwait(false);
  425. return ToOptimizedResult(result);
  426. }
  427. public async Task<object> Get(GetLiveTvRegistrationInfo request)
  428. {
  429. var result = await _liveTvManager.GetRegistrationInfo(request.ChannelId, request.ProgramId, request.Feature).ConfigureAwait(false);
  430. return ToOptimizedResult(result);
  431. }
  432. public object Get(GetSatIniMappings request)
  433. {
  434. return ToOptimizedResult(_liveTvManager.GetSatIniMappings());
  435. }
  436. public async Task<object> Get(GetSchedulesDirectCountries request)
  437. {
  438. // https://json.schedulesdirect.org/20141201/available/countries
  439. var response = await _httpClient.Get(new HttpRequestOptions
  440. {
  441. Url = "https://json.schedulesdirect.org/20141201/available/countries",
  442. CacheLength = TimeSpan.FromDays(1),
  443. CacheMode = CacheMode.Unconditional
  444. }).ConfigureAwait(false);
  445. return ResultFactory.GetResult(response, "application/json");
  446. }
  447. private void AssertUserCanManageLiveTv()
  448. {
  449. var user = SessionContext.GetUser(Request).Result;
  450. if (user == null)
  451. {
  452. throw new SecurityException("Anonymous live tv management is not allowed.");
  453. }
  454. if (!user.Policy.EnableLiveTvManagement)
  455. {
  456. throw new SecurityException("The current user does not have permission to manage live tv.");
  457. }
  458. }
  459. public async Task<object> Post(AddListingProvider request)
  460. {
  461. var result = await _liveTvManager.SaveListingProvider(request, request.ValidateLogin, request.ValidateListings).ConfigureAwait(false);
  462. return ToOptimizedResult(result);
  463. }
  464. public void Delete(DeleteListingProvider request)
  465. {
  466. var config = GetConfiguration();
  467. config.ListingProviders = config.ListingProviders.Where(i => !string.Equals(request.Id, i.Id, StringComparison.OrdinalIgnoreCase)).ToList();
  468. _config.SaveConfiguration("livetv", config);
  469. }
  470. public async Task<object> Post(AddTunerHost request)
  471. {
  472. var result = await _liveTvManager.SaveTunerHost(request).ConfigureAwait(false);
  473. return ToOptimizedResult(result);
  474. }
  475. public void Delete(DeleteTunerHost request)
  476. {
  477. var config = GetConfiguration();
  478. config.TunerHosts = config.TunerHosts.Where(i => !string.Equals(request.Id, i.Id, StringComparison.OrdinalIgnoreCase)).ToList();
  479. _config.SaveConfiguration("livetv", config);
  480. }
  481. private LiveTvOptions GetConfiguration()
  482. {
  483. return _config.GetConfiguration<LiveTvOptions>("livetv");
  484. }
  485. public async Task<object> Get(GetLineups request)
  486. {
  487. var info = await _liveTvManager.GetLineups(request.Type, request.Id, request.Country, request.Location).ConfigureAwait(false);
  488. return ToOptimizedSerializedResultUsingCache(info);
  489. }
  490. public async Task<object> Get(GetLiveTvInfo request)
  491. {
  492. var info = await _liveTvManager.GetLiveTvInfo(CancellationToken.None).ConfigureAwait(false);
  493. return ToOptimizedSerializedResultUsingCache(info);
  494. }
  495. public async Task<object> Get(GetChannels request)
  496. {
  497. var channelResult = await _liveTvManager.GetInternalChannels(new LiveTvChannelQuery
  498. {
  499. ChannelType = request.Type,
  500. UserId = request.UserId,
  501. StartIndex = request.StartIndex,
  502. Limit = request.Limit,
  503. IsFavorite = request.IsFavorite,
  504. IsLiked = request.IsLiked,
  505. IsDisliked = request.IsDisliked,
  506. EnableFavoriteSorting = request.EnableFavoriteSorting,
  507. AddCurrentProgram = request.AddCurrentProgram
  508. }, CancellationToken.None).ConfigureAwait(false);
  509. var user = string.IsNullOrEmpty(request.UserId) ? null : _userManager.GetUserById(request.UserId);
  510. var returnArray = _dtoService.GetBaseItemDtos(channelResult.Items, GetDtoOptions(Request), user).ToArray();
  511. var result = new QueryResult<BaseItemDto>
  512. {
  513. Items = returnArray,
  514. TotalRecordCount = channelResult.TotalRecordCount
  515. };
  516. return ToOptimizedSerializedResultUsingCache(result);
  517. }
  518. public object Get(GetChannel request)
  519. {
  520. var user = string.IsNullOrWhiteSpace(request.UserId) ? null : _userManager.GetUserById(request.UserId);
  521. var item = _libraryManager.GetItemById(request.Id);
  522. var dtoOptions = GetDtoOptions(request);
  523. var result = _dtoService.GetBaseItemDto(item, dtoOptions, user);
  524. return ToOptimizedSerializedResultUsingCache(result);
  525. }
  526. public async Task<object> Get(GetLiveTvFolder request)
  527. {
  528. return ToOptimizedResult(await _liveTvManager.GetLiveTvFolder(request.UserId, CancellationToken.None).ConfigureAwait(false));
  529. }
  530. public async Task<object> Get(GetPrograms request)
  531. {
  532. var query = new ProgramQuery
  533. {
  534. ChannelIds = (request.ChannelIds ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).ToArray(),
  535. UserId = request.UserId,
  536. HasAired = request.HasAired,
  537. EnableTotalRecordCount = request.EnableTotalRecordCount
  538. };
  539. if (!string.IsNullOrEmpty(request.MinStartDate))
  540. {
  541. query.MinStartDate = DateTime.Parse(request.MinStartDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  542. }
  543. if (!string.IsNullOrEmpty(request.MinEndDate))
  544. {
  545. query.MinEndDate = DateTime.Parse(request.MinEndDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  546. }
  547. if (!string.IsNullOrEmpty(request.MaxStartDate))
  548. {
  549. query.MaxStartDate = DateTime.Parse(request.MaxStartDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  550. }
  551. if (!string.IsNullOrEmpty(request.MaxEndDate))
  552. {
  553. query.MaxEndDate = DateTime.Parse(request.MaxEndDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  554. }
  555. query.StartIndex = request.StartIndex;
  556. query.Limit = request.Limit;
  557. query.SortBy = (request.SortBy ?? String.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  558. query.SortOrder = request.SortOrder;
  559. query.IsMovie = request.IsMovie;
  560. query.IsKids = request.IsKids;
  561. query.IsSports = request.IsSports;
  562. query.Genres = (request.Genres ?? String.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  563. var result = await _liveTvManager.GetPrograms(query, GetDtoOptions(request), CancellationToken.None).ConfigureAwait(false);
  564. return ToOptimizedResult(result);
  565. }
  566. public async Task<object> Get(GetRecommendedPrograms request)
  567. {
  568. var query = new RecommendedProgramQuery
  569. {
  570. UserId = request.UserId,
  571. IsAiring = request.IsAiring,
  572. Limit = request.Limit,
  573. HasAired = request.HasAired,
  574. IsMovie = request.IsMovie,
  575. IsKids = request.IsKids,
  576. IsSports = request.IsSports,
  577. EnableTotalRecordCount = request.EnableTotalRecordCount
  578. };
  579. var result = await _liveTvManager.GetRecommendedPrograms(query, GetDtoOptions(request), CancellationToken.None).ConfigureAwait(false);
  580. return ToOptimizedResult(result);
  581. }
  582. public object Post(GetPrograms request)
  583. {
  584. return Get(request);
  585. }
  586. public async Task<object> Get(GetRecordings request)
  587. {
  588. var options = GetDtoOptions(request);
  589. options.DeviceId = AuthorizationContext.GetAuthorizationInfo(Request).DeviceId;
  590. var result = await _liveTvManager.GetRecordings(new RecordingQuery
  591. {
  592. ChannelId = request.ChannelId,
  593. UserId = request.UserId,
  594. GroupId = request.GroupId,
  595. StartIndex = request.StartIndex,
  596. Limit = request.Limit,
  597. Status = request.Status,
  598. SeriesTimerId = request.SeriesTimerId,
  599. IsInProgress = request.IsInProgress
  600. }, options, CancellationToken.None).ConfigureAwait(false);
  601. return ToOptimizedResult(result);
  602. }
  603. public async Task<object> Get(GetRecording request)
  604. {
  605. var user = string.IsNullOrEmpty(request.UserId) ? null : _userManager.GetUserById(request.UserId);
  606. var options = new DtoOptions();
  607. options.DeviceId = AuthorizationContext.GetAuthorizationInfo(Request).DeviceId;
  608. var result = await _liveTvManager.GetRecording(request.Id, options, CancellationToken.None, user).ConfigureAwait(false);
  609. return ToOptimizedSerializedResultUsingCache(result);
  610. }
  611. public async Task<object> Get(GetTimer request)
  612. {
  613. var result = await _liveTvManager.GetTimer(request.Id, CancellationToken.None).ConfigureAwait(false);
  614. return ToOptimizedSerializedResultUsingCache(result);
  615. }
  616. public async Task<object> Get(GetTimers request)
  617. {
  618. var result = await _liveTvManager.GetTimers(new TimerQuery
  619. {
  620. ChannelId = request.ChannelId,
  621. SeriesTimerId = request.SeriesTimerId
  622. }, CancellationToken.None).ConfigureAwait(false);
  623. return ToOptimizedSerializedResultUsingCache(result);
  624. }
  625. public void Delete(DeleteRecording request)
  626. {
  627. AssertUserCanManageLiveTv();
  628. var task = _liveTvManager.DeleteRecording(request.Id);
  629. Task.WaitAll(task);
  630. }
  631. public void Delete(CancelTimer request)
  632. {
  633. AssertUserCanManageLiveTv();
  634. var task = _liveTvManager.CancelTimer(request.Id);
  635. Task.WaitAll(task);
  636. }
  637. public void Post(UpdateTimer request)
  638. {
  639. AssertUserCanManageLiveTv();
  640. var task = _liveTvManager.UpdateTimer(request, CancellationToken.None);
  641. Task.WaitAll(task);
  642. }
  643. public async Task<object> Get(GetSeriesTimers request)
  644. {
  645. var result = await _liveTvManager.GetSeriesTimers(new SeriesTimerQuery
  646. {
  647. SortOrder = request.SortOrder,
  648. SortBy = request.SortBy
  649. }, CancellationToken.None).ConfigureAwait(false);
  650. return ToOptimizedSerializedResultUsingCache(result);
  651. }
  652. public async Task<object> Get(GetSeriesTimer request)
  653. {
  654. var result = await _liveTvManager.GetSeriesTimer(request.Id, CancellationToken.None).ConfigureAwait(false);
  655. return ToOptimizedSerializedResultUsingCache(result);
  656. }
  657. public void Delete(CancelSeriesTimer request)
  658. {
  659. AssertUserCanManageLiveTv();
  660. var task = _liveTvManager.CancelSeriesTimer(request.Id);
  661. Task.WaitAll(task);
  662. }
  663. public void Post(UpdateSeriesTimer request)
  664. {
  665. AssertUserCanManageLiveTv();
  666. var task = _liveTvManager.UpdateSeriesTimer(request, CancellationToken.None);
  667. Task.WaitAll(task);
  668. }
  669. public async Task<object> Get(GetDefaultTimer request)
  670. {
  671. if (string.IsNullOrEmpty(request.ProgramId))
  672. {
  673. var result = await _liveTvManager.GetNewTimerDefaults(CancellationToken.None).ConfigureAwait(false);
  674. return ToOptimizedSerializedResultUsingCache(result);
  675. }
  676. else
  677. {
  678. var result = await _liveTvManager.GetNewTimerDefaults(request.ProgramId, CancellationToken.None).ConfigureAwait(false);
  679. return ToOptimizedSerializedResultUsingCache(result);
  680. }
  681. }
  682. public async Task<object> Get(GetProgram request)
  683. {
  684. var user = string.IsNullOrEmpty(request.UserId) ? null : _userManager.GetUserById(request.UserId);
  685. var result = await _liveTvManager.GetProgram(request.Id, CancellationToken.None, user).ConfigureAwait(false);
  686. return ToOptimizedSerializedResultUsingCache(result);
  687. }
  688. public void Post(CreateSeriesTimer request)
  689. {
  690. AssertUserCanManageLiveTv();
  691. var task = _liveTvManager.CreateSeriesTimer(request, CancellationToken.None);
  692. Task.WaitAll(task);
  693. }
  694. public void Post(CreateTimer request)
  695. {
  696. AssertUserCanManageLiveTv();
  697. var task = _liveTvManager.CreateTimer(request, CancellationToken.None);
  698. Task.WaitAll(task);
  699. }
  700. public async Task<object> Get(GetRecordingGroups request)
  701. {
  702. var result = await _liveTvManager.GetRecordingGroups(new RecordingGroupQuery
  703. {
  704. UserId = request.UserId
  705. }, CancellationToken.None).ConfigureAwait(false);
  706. return ToOptimizedSerializedResultUsingCache(result);
  707. }
  708. public async Task<object> Get(GetRecordingGroup request)
  709. {
  710. var result = await _liveTvManager.GetRecordingGroups(new RecordingGroupQuery
  711. {
  712. }, CancellationToken.None).ConfigureAwait(false);
  713. var group = result.Items.FirstOrDefault(i => string.Equals(i.Id, request.Id, StringComparison.OrdinalIgnoreCase));
  714. return ToOptimizedSerializedResultUsingCache(group);
  715. }
  716. public object Get(GetGuideInfo request)
  717. {
  718. return ToOptimizedResult(_liveTvManager.GetGuideInfo());
  719. }
  720. public void Post(ResetTuner request)
  721. {
  722. AssertUserCanManageLiveTv();
  723. var task = _liveTvManager.ResetTuner(request.Id, CancellationToken.None);
  724. Task.WaitAll(task);
  725. }
  726. }
  727. }