diff options
| author | Joshua M. Boniface <joshua@boniface.me> | 2020-06-13 16:28:37 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-13 16:28:37 -0400 |
| commit | 0011e8df47380936742302ef40639a4626a780ed (patch) | |
| tree | b286c590e9d1dbc00cf1acbf8e50f90713e8faf8 /MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs | |
| parent | d975ad155e7857bcbfcf55246fd78dd87ed594ca (diff) | |
| parent | ec3e15db5789b6218482beb488433f41f9a0d8ba (diff) | |
Merge pull request #3332 from crobibero/api-migration
Merge master into api-migration
Diffstat (limited to 'MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs')
| -rw-r--r-- | MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs new file mode 100644 index 0000000000..de1fcd2591 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs @@ -0,0 +1,67 @@ +using System; +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// <summary> + /// Interface ISyncPlayController. + /// </summary> + public interface ISyncPlayController + { + /// <summary> + /// Gets the group id. + /// </summary> + /// <value>The group id.</value> + Guid GetGroupId(); + + /// <summary> + /// Gets the playing item id. + /// </summary> + /// <value>The playing item id.</value> + Guid GetPlayingItemId(); + + /// <summary> + /// Checks if the group is empty. + /// </summary> + /// <value>If the group is empty.</value> + bool IsGroupEmpty(); + + /// <summary> + /// Initializes the group with the session's info. + /// </summary> + /// <param name="session">The session.</param> + /// <param name="cancellationToken">The cancellation token.</param> + void InitGroup(SessionInfo session, CancellationToken cancellationToken); + + /// <summary> + /// Adds the session to the group. + /// </summary> + /// <param name="session">The session.</param> + /// <param name="request">The request.</param> + /// <param name="cancellationToken">The cancellation token.</param> + void SessionJoin(SessionInfo session, JoinGroupRequest request, CancellationToken cancellationToken); + + /// <summary> + /// Removes the session from the group. + /// </summary> + /// <param name="session">The session.</param> + /// <param name="cancellationToken">The cancellation token.</param> + void SessionLeave(SessionInfo session, CancellationToken cancellationToken); + + /// <summary> + /// Handles the requested action by the session. + /// </summary> + /// <param name="session">The session.</param> + /// <param name="request">The requested action.</param> + /// <param name="cancellationToken">The cancellation token.</param> + void HandleRequest(SessionInfo session, PlaybackRequest request, CancellationToken cancellationToken); + + /// <summary> + /// Gets the info about the group for the clients. + /// </summary> + /// <value>The group info for the clients.</value> + GroupInfoView GetInfo(); + } +}
\ No newline at end of file |
