IGroupState.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. using System.Threading;
  2. using MediaBrowser.Controller.Session;
  3. using MediaBrowser.Controller.SyncPlay.PlaybackRequests;
  4. using MediaBrowser.Model.SyncPlay;
  5. namespace MediaBrowser.Controller.SyncPlay
  6. {
  7. /// <summary>
  8. /// Interface IGroupState.
  9. /// </summary>
  10. public interface IGroupState
  11. {
  12. /// <summary>
  13. /// Gets the group state type.
  14. /// </summary>
  15. /// <value>The group state type.</value>
  16. GroupStateType Type { get; }
  17. /// <summary>
  18. /// Handles a session that joined the group.
  19. /// </summary>
  20. /// <param name="context">The context of the state.</param>
  21. /// <param name="prevState">The previous state.</param>
  22. /// <param name="session">The session.</param>
  23. /// <param name="cancellationToken">The cancellation token.</param>
  24. void SessionJoined(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  25. /// <summary>
  26. /// Handles a session that is leaving the group.
  27. /// </summary>
  28. /// <param name="context">The context of the state.</param>
  29. /// <param name="prevState">The previous state.</param>
  30. /// <param name="session">The session.</param>
  31. /// <param name="cancellationToken">The cancellation token.</param>
  32. void SessionLeaving(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  33. /// <summary>
  34. /// Generic handler. Context's state can change.
  35. /// </summary>
  36. /// <param name="request">The generic request.</param>
  37. /// <param name="context">The context of the state.</param>
  38. /// <param name="prevState">The previous state.</param>
  39. /// <param name="session">The session.</param>
  40. /// <param name="cancellationToken">The cancellation token.</param>
  41. void HandleRequest(IGroupPlaybackRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  42. /// <summary>
  43. /// Handles a play request from a session. Context's state can change.
  44. /// </summary>
  45. /// <param name="request">The play request.</param>
  46. /// <param name="context">The context of the state.</param>
  47. /// <param name="prevState">The previous state.</param>
  48. /// <param name="session">The session.</param>
  49. /// <param name="cancellationToken">The cancellation token.</param>
  50. void HandleRequest(PlayGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  51. /// <summary>
  52. /// Handles a set-playlist-item request from a session. Context's state can change.
  53. /// </summary>
  54. /// <param name="request">The set-playlist-item request.</param>
  55. /// <param name="context">The context of the state.</param>
  56. /// <param name="prevState">The previous state.</param>
  57. /// <param name="session">The session.</param>
  58. /// <param name="cancellationToken">The cancellation token.</param>
  59. void HandleRequest(SetPlaylistItemGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  60. /// <summary>
  61. /// Handles a remove-items request from a session. Context's state can change.
  62. /// </summary>
  63. /// <param name="request">The remove-items request.</param>
  64. /// <param name="context">The context of the state.</param>
  65. /// <param name="prevState">The previous state.</param>
  66. /// <param name="session">The session.</param>
  67. /// <param name="cancellationToken">The cancellation token.</param>
  68. void HandleRequest(RemoveFromPlaylistGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  69. /// <summary>
  70. /// Handles a move-playlist-item request from a session. Context's state should not change.
  71. /// </summary>
  72. /// <param name="request">The move-playlist-item request.</param>
  73. /// <param name="context">The context of the state.</param>
  74. /// <param name="prevState">The previous state.</param>
  75. /// <param name="session">The session.</param>
  76. /// <param name="cancellationToken">The cancellation token.</param>
  77. void HandleRequest(MovePlaylistItemGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  78. /// <summary>
  79. /// Handles a queue request from a session. Context's state should not change.
  80. /// </summary>
  81. /// <param name="request">The queue request.</param>
  82. /// <param name="context">The context of the state.</param>
  83. /// <param name="prevState">The previous state.</param>
  84. /// <param name="session">The session.</param>
  85. /// <param name="cancellationToken">The cancellation token.</param>
  86. void HandleRequest(QueueGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  87. /// <summary>
  88. /// Handles an unpause request from a session. Context's state can change.
  89. /// </summary>
  90. /// <param name="request">The unpause request.</param>
  91. /// <param name="context">The context of the state.</param>
  92. /// <param name="prevState">The previous state.</param>
  93. /// <param name="session">The session.</param>
  94. /// <param name="cancellationToken">The cancellation token.</param>
  95. void HandleRequest(UnpauseGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  96. /// <summary>
  97. /// Handles a pause request from a session. Context's state can change.
  98. /// </summary>
  99. /// <param name="request">The pause request.</param>
  100. /// <param name="context">The context of the state.</param>
  101. /// <param name="prevState">The previous state.</param>
  102. /// <param name="session">The session.</param>
  103. /// <param name="cancellationToken">The cancellation token.</param>
  104. void HandleRequest(PauseGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  105. /// <summary>
  106. /// Handles a stop request from a session. Context's state can change.
  107. /// </summary>
  108. /// <param name="request">The stop request.</param>
  109. /// <param name="context">The context of the state.</param>
  110. /// <param name="prevState">The previous state.</param>
  111. /// <param name="session">The session.</param>
  112. /// <param name="cancellationToken">The cancellation token.</param>
  113. void HandleRequest(StopGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  114. /// <summary>
  115. /// Handles a seek request from a session. Context's state can change.
  116. /// </summary>
  117. /// <param name="request">The seek request.</param>
  118. /// <param name="context">The context of the state.</param>
  119. /// <param name="prevState">The previous state.</param>
  120. /// <param name="session">The session.</param>
  121. /// <param name="cancellationToken">The cancellation token.</param>
  122. void HandleRequest(SeekGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  123. /// <summary>
  124. /// Handles a buffer request from a session. Context's state can change.
  125. /// </summary>
  126. /// <param name="request">The buffer request.</param>
  127. /// <param name="context">The context of the state.</param>
  128. /// <param name="prevState">The previous state.</param>
  129. /// <param name="session">The session.</param>
  130. /// <param name="cancellationToken">The cancellation token.</param>
  131. void HandleRequest(BufferGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  132. /// <summary>
  133. /// Handles a ready request from a session. Context's state can change.
  134. /// </summary>
  135. /// <param name="request">The ready request.</param>
  136. /// <param name="context">The context of the state.</param>
  137. /// <param name="prevState">The previous state.</param>
  138. /// <param name="session">The session.</param>
  139. /// <param name="cancellationToken">The cancellation token.</param>
  140. void HandleRequest(ReadyGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  141. /// <summary>
  142. /// Handles a next-item request from a session. Context's state can change.
  143. /// </summary>
  144. /// <param name="request">The next-item request.</param>
  145. /// <param name="context">The context of the state.</param>
  146. /// <param name="prevState">The previous state.</param>
  147. /// <param name="session">The session.</param>
  148. /// <param name="cancellationToken">The cancellation token.</param>
  149. void HandleRequest(NextItemGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  150. /// <summary>
  151. /// Handles a previous-item request from a session. Context's state can change.
  152. /// </summary>
  153. /// <param name="request">The previous-item request.</param>
  154. /// <param name="context">The context of the state.</param>
  155. /// <param name="prevState">The previous state.</param>
  156. /// <param name="session">The session.</param>
  157. /// <param name="cancellationToken">The cancellation token.</param>
  158. void HandleRequest(PreviousItemGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  159. /// <summary>
  160. /// Handles a set-repeat-mode request from a session. Context's state should not change.
  161. /// </summary>
  162. /// <param name="request">The repeat-mode request.</param>
  163. /// <param name="context">The context of the state.</param>
  164. /// <param name="prevState">The previous state.</param>
  165. /// <param name="session">The session.</param>
  166. /// <param name="cancellationToken">The cancellation token.</param>
  167. void HandleRequest(SetRepeatModeGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  168. /// <summary>
  169. /// Handles a set-shuffle-mode request from a session. Context's state should not change.
  170. /// </summary>
  171. /// <param name="request">The shuffle-mode request.</param>
  172. /// <param name="context">The context of the state.</param>
  173. /// <param name="prevState">The previous state.</param>
  174. /// <param name="session">The session.</param>
  175. /// <param name="cancellationToken">The cancellation token.</param>
  176. void HandleRequest(SetShuffleModeGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  177. /// <summary>
  178. /// Updates the ping of a session. Context's state should not change.
  179. /// </summary>
  180. /// <param name="request">The ping request.</param>
  181. /// <param name="context">The context of the state.</param>
  182. /// <param name="prevState">The previous state.</param>
  183. /// <param name="session">The session.</param>
  184. /// <param name="cancellationToken">The cancellation token.</param>
  185. void HandleRequest(PingGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  186. /// <summary>
  187. /// Handles a ignore-wait request from a session. Context's state can change.
  188. /// </summary>
  189. /// <param name="request">The ignore-wait request.</param>
  190. /// <param name="context">The context of the state.</param>
  191. /// <param name="prevState">The previous state.</param>
  192. /// <param name="session">The session.</param>
  193. /// <param name="cancellationToken">The cancellation token.</param>
  194. void HandleRequest(IgnoreWaitGroupRequest request, IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken);
  195. }
  196. }