aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs
diff options
context:
space:
mode:
Diffstat (limited to 'MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs')
-rw-r--r--MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs165
1 files changed, 143 insertions, 22 deletions
diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs
index 55c9ee938f..290576e30f 100644
--- a/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs
+++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs
@@ -16,80 +16,201 @@ namespace MediaBrowser.Controller.SyncPlay
GroupState GetGroupState();
/// <summary>
+ /// Handle a session that joined the group.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Handle a session that is leaving the group.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void SessionLeaving(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
/// Generic handle. Context's state can change.
/// </summary>
/// <param name="context">The context of the state.</param>
- /// <param name="newState">Whether the state has been just set.</param>
- /// <param name="request">The play action.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The generic action.</param>
/// <param name="session">The session.</param>
/// <param name="cancellationToken">The cancellation token.</param>
- /// <value>The operation completion status.</value>
- bool HandleRequest(ISyncPlayStateContext context, bool newState, IPlaybackGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, IPlaybackGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
/// <summary>
/// Handles a play action requested by a session. Context's state can change.
/// </summary>
/// <param name="context">The context of the state.</param>
- /// <param name="newState">Whether the state has been just set.</param>
+ /// <param name="prevState">The previous state.</param>
/// <param name="request">The play action.</param>
/// <param name="session">The session.</param>
/// <param name="cancellationToken">The cancellation token.</param>
- /// <value>The operation completion status.</value>
- bool HandleRequest(ISyncPlayStateContext context, bool newState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Handles a playlist-item change requested by a session. Context's state can change.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The playlist-item change action.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SetPlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Handles a remove-items change requested by a session. Context's state can change.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The remove-items change action.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, RemoveFromPlaylistGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Handles a move-item change requested by a session. Context's state should not change.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The move-item change action.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, MovePlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Handles a queue change requested by a session. Context's state should not change.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The queue action.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, QueueGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Handles an unpause action requested by a session. Context's state can change.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The unpause action.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
/// <summary>
/// Handles a pause action requested by a session. Context's state can change.
/// </summary>
/// <param name="context">The context of the state.</param>
- /// <param name="newState">Whether the state has been just set.</param>
+ /// <param name="prevState">The previous state.</param>
/// <param name="request">The pause action.</param>
/// <param name="session">The session.</param>
/// <param name="cancellationToken">The cancellation token.</param>
- /// <value>The operation completion status.</value>
- bool HandleRequest(ISyncPlayStateContext context, bool newState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Handles a stop action requested by a session. Context's state can change.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The stop action.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
/// <summary>
/// Handles a seek action requested by a session. Context's state can change.
/// </summary>
/// <param name="context">The context of the state.</param>
- /// <param name="newState">Whether the state has been just set.</param>
+ /// <param name="prevState">The previous state.</param>
/// <param name="request">The seek action.</param>
/// <param name="session">The session.</param>
/// <param name="cancellationToken">The cancellation token.</param>
- /// <value>The operation completion status.</value>
- bool HandleRequest(ISyncPlayStateContext context, bool newState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
/// <summary>
/// Handles a buffering action requested by a session. Context's state can change.
/// </summary>
/// <param name="context">The context of the state.</param>
- /// <param name="newState">Whether the state has been just set.</param>
+ /// <param name="prevState">The previous state.</param>
/// <param name="request">The buffering action.</param>
/// <param name="session">The session.</param>
/// <param name="cancellationToken">The cancellation token.</param>
- /// <value>The operation completion status.</value>
- bool HandleRequest(ISyncPlayStateContext context, bool newState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
/// <summary>
/// Handles a buffering-done action requested by a session. Context's state can change.
/// </summary>
/// <param name="context">The context of the state.</param>
- /// <param name="newState">Whether the state has been just set.</param>
+ /// <param name="prevState">The previous state.</param>
/// <param name="request">The buffering-done action.</param>
/// <param name="session">The session.</param>
/// <param name="cancellationToken">The cancellation token.</param>
- /// <value>The operation completion status.</value>
- bool HandleRequest(ISyncPlayStateContext context, bool newState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Handles a next-track action requested by a session. Context's state can change.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The next-track action.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Handles a previous-track action requested by a session. Context's state can change.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The previous-track action.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Handles a repeat-mode change requested by a session. Context's state should not change.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The repeat-mode action.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SetRepeatModeGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Handles a shuffle-mode change requested by a session. Context's state should not change.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The shuffle-mode action.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SetShuffleModeGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
/// <summary>
/// Updates ping of a session. Context's state should not change.
/// </summary>
/// <param name="context">The context of the state.</param>
- /// <param name="newState">Whether the state has been just set.</param>
+ /// <param name="prevState">The previous state.</param>
/// <param name="request">The buffering-done action.</param>
/// <param name="session">The session.</param>
/// <param name="cancellationToken">The cancellation token.</param>
- /// <value>The operation completion status.</value>
- bool HandleRequest(ISyncPlayStateContext context, bool newState, PingGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PingGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Updates whether the session should be considered during group wait. Context's state should not change.
+ /// </summary>
+ /// <param name="context">The context of the state.</param>
+ /// <param name="prevState">The previous state.</param>
+ /// <param name="request">The ignore-wait action.</param>
+ /// <param name="session">The session.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ void HandleRequest(ISyncPlayStateContext context, GroupState prevState, IgnoreWaitGroupRequest request, SessionInfo session, CancellationToken cancellationToken);
}
}