aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs
diff options
context:
space:
mode:
authorDavid <daullmer@gmail.com>2020-06-14 12:43:10 +0200
committerDavid <daullmer@gmail.com>2020-06-14 12:43:10 +0200
commitcf3d0f8d519ca1b43c78d5dde9f5b43fec6e3334 (patch)
treee1f83eeb7920f3c68fc3d5f41242e3d24958227d /MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs
parentb16da095493bc207f4196b8b61cfc768a237a5bc (diff)
parent0011e8df47380936742302ef40639a4626a780ed (diff)
Merge remote-tracking branch 'remotes/upstream/api-migration' into api-system
Diffstat (limited to 'MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs')
-rw-r--r--MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs67
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 000000000..de1fcd259
--- /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