ILiveTvManager.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. using MediaBrowser.Controller.Channels;
  2. using MediaBrowser.Controller.Entities;
  3. using MediaBrowser.Model.Dto;
  4. using MediaBrowser.Model.LiveTv;
  5. using MediaBrowser.Model.Querying;
  6. using System.Collections.Generic;
  7. using System.Threading;
  8. using System.Threading.Tasks;
  9. namespace MediaBrowser.Controller.LiveTv
  10. {
  11. /// <summary>
  12. /// Manages all live tv services installed on the server
  13. /// </summary>
  14. public interface ILiveTvManager
  15. {
  16. /// <summary>
  17. /// Gets the services.
  18. /// </summary>
  19. /// <value>The services.</value>
  20. IReadOnlyList<ILiveTvService> Services { get; }
  21. /// <summary>
  22. /// Gets the new timer defaults asynchronous.
  23. /// </summary>
  24. /// <param name="cancellationToken">The cancellation token.</param>
  25. /// <returns>Task{TimerInfo}.</returns>
  26. Task<SeriesTimerInfoDto> GetNewTimerDefaults(CancellationToken cancellationToken);
  27. /// <summary>
  28. /// Gets the new timer defaults.
  29. /// </summary>
  30. /// <param name="programId">The program identifier.</param>
  31. /// <param name="cancellationToken">The cancellation token.</param>
  32. /// <returns>Task{SeriesTimerInfoDto}.</returns>
  33. Task<SeriesTimerInfoDto> GetNewTimerDefaults(string programId, CancellationToken cancellationToken);
  34. /// <summary>
  35. /// Deletes the recording.
  36. /// </summary>
  37. /// <param name="id">The identifier.</param>
  38. /// <returns>Task.</returns>
  39. Task DeleteRecording(string id);
  40. /// <summary>
  41. /// Cancels the timer.
  42. /// </summary>
  43. /// <param name="id">The identifier.</param>
  44. /// <returns>Task.</returns>
  45. Task CancelTimer(string id);
  46. /// <summary>
  47. /// Cancels the series timer.
  48. /// </summary>
  49. /// <param name="id">The identifier.</param>
  50. /// <returns>Task.</returns>
  51. Task CancelSeriesTimer(string id);
  52. /// <summary>
  53. /// Adds the parts.
  54. /// </summary>
  55. /// <param name="services">The services.</param>
  56. void AddParts(IEnumerable<ILiveTvService> services);
  57. /// <summary>
  58. /// Gets the channels.
  59. /// </summary>
  60. /// <param name="query">The query.</param>
  61. /// <param name="cancellationToken">The cancellation token.</param>
  62. /// <returns>IEnumerable{Channel}.</returns>
  63. Task<QueryResult<ChannelInfoDto>> GetChannels(LiveTvChannelQuery query, CancellationToken cancellationToken);
  64. /// <summary>
  65. /// Gets the recording.
  66. /// </summary>
  67. /// <param name="id">The identifier.</param>
  68. /// <param name="user">The user.</param>
  69. /// <param name="cancellationToken">The cancellation token.</param>
  70. /// <returns>Task{RecordingInfoDto}.</returns>
  71. Task<RecordingInfoDto> GetRecording(string id, CancellationToken cancellationToken, User user = null);
  72. /// <summary>
  73. /// Gets the channel.
  74. /// </summary>
  75. /// <param name="id">The identifier.</param>
  76. /// <param name="cancellationToken">The cancellation token.</param>
  77. /// <param name="user">The user.</param>
  78. /// <returns>Task{RecordingInfoDto}.</returns>
  79. Task<ChannelInfoDto> GetChannel(string id, CancellationToken cancellationToken, User user = null);
  80. /// <summary>
  81. /// Gets the timer.
  82. /// </summary>
  83. /// <param name="id">The identifier.</param>
  84. /// <param name="cancellationToken">The cancellation token.</param>
  85. /// <returns>Task{TimerInfoDto}.</returns>
  86. Task<TimerInfoDto> GetTimer(string id, CancellationToken cancellationToken);
  87. /// <summary>
  88. /// Gets the series timer.
  89. /// </summary>
  90. /// <param name="id">The identifier.</param>
  91. /// <param name="cancellationToken">The cancellation token.</param>
  92. /// <returns>Task{TimerInfoDto}.</returns>
  93. Task<SeriesTimerInfoDto> GetSeriesTimer(string id, CancellationToken cancellationToken);
  94. /// <summary>
  95. /// Gets the recordings.
  96. /// </summary>
  97. /// <param name="query">The query.</param>
  98. /// <param name="cancellationToken">The cancellation token.</param>
  99. /// <returns>QueryResult{RecordingInfoDto}.</returns>
  100. Task<QueryResult<RecordingInfoDto>> GetRecordings(RecordingQuery query, CancellationToken cancellationToken);
  101. /// <summary>
  102. /// Gets the timers.
  103. /// </summary>
  104. /// <param name="query">The query.</param>
  105. /// <param name="cancellationToken">The cancellation token.</param>
  106. /// <returns>Task{QueryResult{TimerInfoDto}}.</returns>
  107. Task<QueryResult<TimerInfoDto>> GetTimers(TimerQuery query, CancellationToken cancellationToken);
  108. /// <summary>
  109. /// Gets the series timers.
  110. /// </summary>
  111. /// <param name="query">The query.</param>
  112. /// <param name="cancellationToken">The cancellation token.</param>
  113. /// <returns>Task{QueryResult{SeriesTimerInfoDto}}.</returns>
  114. Task<QueryResult<SeriesTimerInfoDto>> GetSeriesTimers(SeriesTimerQuery query, CancellationToken cancellationToken);
  115. /// <summary>
  116. /// Gets the channel.
  117. /// </summary>
  118. /// <param name="id">The identifier.</param>
  119. /// <returns>Channel.</returns>
  120. LiveTvChannel GetInternalChannel(string id);
  121. /// <summary>
  122. /// Gets the recording.
  123. /// </summary>
  124. /// <param name="id">The identifier.</param>
  125. /// <param name="cancellationToken">The cancellation token.</param>
  126. /// <returns>LiveTvRecording.</returns>
  127. Task<ILiveTvRecording> GetInternalRecording(string id, CancellationToken cancellationToken);
  128. /// <summary>
  129. /// Gets the recording stream.
  130. /// </summary>
  131. /// <param name="id">The identifier.</param>
  132. /// <param name="cancellationToken">The cancellation token.</param>
  133. /// <returns>Task{Stream}.</returns>
  134. Task<MediaSourceInfo> GetRecordingStream(string id, CancellationToken cancellationToken);
  135. /// <summary>
  136. /// Gets the channel stream.
  137. /// </summary>
  138. /// <param name="id">The identifier.</param>
  139. /// <param name="cancellationToken">The cancellation token.</param>
  140. /// <returns>Task{StreamResponseInfo}.</returns>
  141. Task<MediaSourceInfo> GetChannelStream(string id, CancellationToken cancellationToken);
  142. /// <summary>
  143. /// Gets the program.
  144. /// </summary>
  145. /// <param name="id">The identifier.</param>
  146. /// <param name="cancellationToken">The cancellation token.</param>
  147. /// <param name="user">The user.</param>
  148. /// <returns>Task{ProgramInfoDto}.</returns>
  149. Task<ProgramInfoDto> GetProgram(string id, CancellationToken cancellationToken, User user = null);
  150. /// <summary>
  151. /// Gets the programs.
  152. /// </summary>
  153. /// <param name="query">The query.</param>
  154. /// <param name="cancellationToken">The cancellation token.</param>
  155. /// <returns>IEnumerable{ProgramInfo}.</returns>
  156. Task<QueryResult<ProgramInfoDto>> GetPrograms(ProgramQuery query, CancellationToken cancellationToken);
  157. /// <summary>
  158. /// Updates the timer.
  159. /// </summary>
  160. /// <param name="timer">The timer.</param>
  161. /// <param name="cancellationToken">The cancellation token.</param>
  162. /// <returns>Task.</returns>
  163. Task UpdateTimer(TimerInfoDto timer, CancellationToken cancellationToken);
  164. /// <summary>
  165. /// Updates the timer.
  166. /// </summary>
  167. /// <param name="timer">The timer.</param>
  168. /// <param name="cancellationToken">The cancellation token.</param>
  169. /// <returns>Task.</returns>
  170. Task UpdateSeriesTimer(SeriesTimerInfoDto timer, CancellationToken cancellationToken);
  171. /// <summary>
  172. /// Creates the timer.
  173. /// </summary>
  174. /// <param name="timer">The timer.</param>
  175. /// <param name="cancellationToken">The cancellation token.</param>
  176. /// <returns>Task.</returns>
  177. Task CreateTimer(TimerInfoDto timer, CancellationToken cancellationToken);
  178. /// <summary>
  179. /// Creates the series timer.
  180. /// </summary>
  181. /// <param name="timer">The timer.</param>
  182. /// <param name="cancellationToken">The cancellation token.</param>
  183. /// <returns>Task.</returns>
  184. Task CreateSeriesTimer(SeriesTimerInfoDto timer, CancellationToken cancellationToken);
  185. /// <summary>
  186. /// Gets the recording groups.
  187. /// </summary>
  188. /// <param name="query">The query.</param>
  189. /// <param name="cancellationToken">The cancellation token.</param>
  190. /// <returns>Task{QueryResult{RecordingGroupDto}}.</returns>
  191. Task<QueryResult<RecordingGroupDto>> GetRecordingGroups(RecordingGroupQuery query, CancellationToken cancellationToken);
  192. /// <summary>
  193. /// Closes the live stream.
  194. /// </summary>
  195. /// <param name="id">The identifier.</param>
  196. /// <param name="cancellationToken">The cancellation token.</param>
  197. /// <returns>Task.</returns>
  198. Task CloseLiveStream(string id, CancellationToken cancellationToken);
  199. /// <summary>
  200. /// Gets the guide information.
  201. /// </summary>
  202. /// <returns>GuideInfo.</returns>
  203. GuideInfo GetGuideInfo();
  204. /// <summary>
  205. /// Gets the recommended programs.
  206. /// </summary>
  207. /// <param name="query">The query.</param>
  208. /// <param name="cancellationToken">The cancellation token.</param>
  209. /// <returns>Task{QueryResult{ProgramInfoDto}}.</returns>
  210. Task<QueryResult<ProgramInfoDto>> GetRecommendedPrograms(RecommendedProgramQuery query,
  211. CancellationToken cancellationToken);
  212. /// <summary>
  213. /// Gets the recommended programs internal.
  214. /// </summary>
  215. /// <param name="query">The query.</param>
  216. /// <param name="cancellationToken">The cancellation token.</param>
  217. /// <returns>Task&lt;QueryResult&lt;LiveTvProgram&gt;&gt;.</returns>
  218. Task<QueryResult<LiveTvProgram>> GetRecommendedProgramsInternal(RecommendedProgramQuery query,
  219. CancellationToken cancellationToken);
  220. /// <summary>
  221. /// Gets the live tv information.
  222. /// </summary>
  223. /// <param name="cancellationToken">The cancellation token.</param>
  224. /// <returns>Task{LiveTvInfo}.</returns>
  225. Task<LiveTvInfo> GetLiveTvInfo(CancellationToken cancellationToken);
  226. /// <summary>
  227. /// Resets the tuner.
  228. /// </summary>
  229. /// <param name="id">The identifier.</param>
  230. /// <param name="cancellationToken">The cancellation token.</param>
  231. /// <returns>Task.</returns>
  232. Task ResetTuner(string id, CancellationToken cancellationToken);
  233. /// <summary>
  234. /// Gets the live tv folder.
  235. /// </summary>
  236. /// <param name="userId">The user identifier.</param>
  237. /// <param name="cancellationToken">The cancellation token.</param>
  238. /// <returns>BaseItemDto.</returns>
  239. Task<Folder> GetInternalLiveTvFolder(string userId, CancellationToken cancellationToken);
  240. /// <summary>
  241. /// Gets the live tv folder.
  242. /// </summary>
  243. /// <param name="userId">The user identifier.</param>
  244. /// <param name="cancellationToken">The cancellation token.</param>
  245. /// <returns>BaseItemDto.</returns>
  246. Task<BaseItemDto> GetLiveTvFolder(string userId, CancellationToken cancellationToken);
  247. /// <summary>
  248. /// Gets the enabled users.
  249. /// </summary>
  250. /// <returns>IEnumerable{User}.</returns>
  251. IEnumerable<User> GetEnabledUsers();
  252. /// <summary>
  253. /// Gets the internal channels.
  254. /// </summary>
  255. /// <param name="query">The query.</param>
  256. /// <param name="cancellationToken">The cancellation token.</param>
  257. /// <returns>Task&lt;QueryResult&lt;LiveTvChannel&gt;&gt;.</returns>
  258. Task<QueryResult<LiveTvChannel>> GetInternalChannels(LiveTvChannelQuery query,
  259. CancellationToken cancellationToken);
  260. /// <summary>
  261. /// Gets the internal recordings.
  262. /// </summary>
  263. /// <param name="query">The query.</param>
  264. /// <param name="cancellationToken">The cancellation token.</param>
  265. /// <returns>Task&lt;QueryResult&lt;BaseItem&gt;&gt;.</returns>
  266. Task<QueryResult<BaseItem>> GetInternalRecordings(RecordingQuery query, CancellationToken cancellationToken);
  267. }
  268. }