Rename Syncplay to SyncPlay

MediaBrowser.Controller/SyncPlay/GroupInfo.cs

@@ -0,0 +1,150 @@
+using System;
+using System.Collections.Generic;
+using MediaBrowser.Controller.Entities;
+using MediaBrowser.Controller.Session;
+
+namespace MediaBrowser.Controller.SyncPlay
+{
+    /// <summary>
+    /// Class GroupInfo.
+    /// </summary>
+    /// <remarks>
+    /// Class is not thread-safe, external locking is required when accessing methods.
+    /// </remarks>
+    public class GroupInfo
+    {
+        /// <summary>
+        /// Default ping value used for sessions.
+        /// </summary>
+        public readonly long DefaulPing = 500;
+        /// <summary>
+        /// Gets or sets the group identifier.
+        /// </summary>
+        /// <value>The group identifier.</value>
+        public readonly Guid GroupId = Guid.NewGuid();
+
+        /// <summary>
+        /// Gets or sets the playing item.
+        /// </summary>
+        /// <value>The playing item.</value>
+        public BaseItem PlayingItem { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether playback is paused.
+        /// </summary>
+        /// <value>Playback is paused.</value>
+        public bool IsPaused { get; set; }
+
+        /// <summary>
+        /// Gets or sets the position ticks.
+        /// </summary>
+        /// <value>The position ticks.</value>
+        public long PositionTicks { get; set; }
+
+        /// <summary>
+        /// Gets or sets the last activity.
+        /// </summary>
+        /// <value>The last activity.</value>
+        public DateTime LastActivity { get; set; }
+
+        /// <summary>
+        /// Gets the participants.
+        /// </summary>
+        /// <value>The participants, or members of the group.</value>
+        public readonly Dictionary<string, GroupMember> Participants =
+            new Dictionary<string, GroupMember>(StringComparer.OrdinalIgnoreCase);
+
+        /// <summary>
+        /// Checks if a session is in this group.
+        /// </summary>
+        /// <value><c>true</c> if the session is in this group; <c>false</c> otherwise.</value>
+        public bool ContainsSession(string sessionId)
+        {
+            return Participants.ContainsKey(sessionId);
+        }
+
+        /// <summary>
+        /// Adds the session to the group.
+        /// </summary>
+        /// <param name="session">The session.</param>
+        public void AddSession(SessionInfo session)
+        {
+            if (ContainsSession(session.Id.ToString())) return;
+            var member = new GroupMember();
+            member.Session = session;
+            member.Ping = DefaulPing;
+            member.IsBuffering = false;
+            Participants[session.Id.ToString()] = member;
+        }
+
+        /// <summary>
+        /// Removes the session from the group.
+        /// </summary>
+        /// <param name="session">The session.</param>
+
+        public void RemoveSession(SessionInfo session)
+        {
+            if (!ContainsSession(session.Id.ToString())) return;
+            GroupMember member;
+            Participants.Remove(session.Id.ToString(), out member);
+        }
+
+        /// <summary>
+        /// Updates the ping of a session.
+        /// </summary>
+        /// <param name="session">The session.</param>
+        /// <param name="ping">The ping.</param>
+        public void UpdatePing(SessionInfo session, long ping)
+        {
+            if (!ContainsSession(session.Id.ToString())) return;
+            Participants[session.Id.ToString()].Ping = ping;
+        }
+
+        /// <summary>
+        /// Gets the highest ping in the group.
+        /// </summary>
+        /// <value name="session">The highest ping in the group.</value>
+        public long GetHighestPing()
+        {
+            long max = Int64.MinValue;
+            foreach (var session in Participants.Values)
+            {
+                max = Math.Max(max, session.Ping);
+            }
+            return max;
+        }
+
+        /// <summary>
+        /// Sets the session's buffering state.
+        /// </summary>
+        /// <param name="session">The session.</param>
+        /// <param name="isBuffering">The state.</param>
+        public void SetBuffering(SessionInfo session, bool isBuffering)
+        {
+            if (!ContainsSession(session.Id.ToString())) return;
+            Participants[session.Id.ToString()].IsBuffering = isBuffering;
+        }
+
+        /// <summary>
+        /// Gets the group buffering state.
+        /// </summary>
+        /// <value><c>true</c> if there is a session buffering in the group; <c>false</c> otherwise.</value>
+        public bool IsBuffering()
+        {
+            foreach (var session in Participants.Values)
+            {
+                if (session.IsBuffering) return true;
+            }
+            return false;
+        }
+
+        /// <summary>
+        /// Checks if the group is empty.
+        /// </summary>
+        /// <value><c>true</c> if the group is empty; <c>false</c> otherwise.</value>
+        public bool IsEmpty()
+        {
+            return Participants.Count == 0;
+        }
+    }
+}

MediaBrowser.Controller/SyncPlay/GroupMember.cs

@@ -0,0 +1,28 @@
+using MediaBrowser.Controller.Session;
+
+namespace MediaBrowser.Controller.SyncPlay
+{
+    /// <summary>
+    /// Class GroupMember.
+    /// </summary>
+    public class GroupMember
+    {
+        /// <summary>
+        /// Gets or sets whether this member is buffering.
+        /// </summary>
+        /// <value><c>true</c> if member is buffering; <c>false</c> otherwise.</value>
+        public bool IsBuffering { get; set; }
+
+        /// <summary>
+        /// Gets or sets the session.
+        /// </summary>
+        /// <value>The session.</value>
+        public SessionInfo Session { get; set; }
+
+        /// <summary>
+        /// Gets or sets the ping.
+        /// </summary>
+        /// <value>The ping.</value>
+        public long Ping { get; set; }
+    }
+}

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();
+    }
+}

MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs

@@ -0,0 +1,69 @@
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using MediaBrowser.Controller.Session;
+using MediaBrowser.Model.SyncPlay;
+
+namespace MediaBrowser.Controller.SyncPlay
+{
+    /// <summary>
+    /// Interface ISyncPlayManager.
+    /// </summary>
+    public interface ISyncPlayManager
+    {
+        /// <summary>
+        /// Creates a new group.
+        /// </summary>
+        /// <param name="session">The session that's creating the group.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        void NewGroup(SessionInfo session, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Adds the session to a group.
+        /// </summary>
+        /// <param name="session">The session.</param>
+        /// <param name="groupId">The group id.</param>
+        /// <param name="request">The request.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        void JoinGroup(SessionInfo session, string groupId, JoinGroupRequest request, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Removes the session from a group.
+        /// </summary>
+        /// <param name="session">The session.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        void LeaveGroup(SessionInfo session, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Gets list of available groups for a session.
+        /// </summary>
+        /// <param name="session">The session.</param>
+        /// <param name="filterItemId">The item id to filter by.</param>
+        /// <value>The list of available groups.</value>
+        List<GroupInfoView> ListGroups(SessionInfo session, Guid filterItemId);
+
+        /// <summary>
+        /// Handle a request by a session in a group.
+        /// </summary>
+        /// <param name="session">The session.</param>
+        /// <param name="request">The request.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        void HandleRequest(SessionInfo session, PlaybackRequest request, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Maps a session to a group.
+        /// </summary>
+        /// <param name="session">The session.</param>
+        /// <param name="group">The group.</param>
+        /// <exception cref="InvalidOperationException"></exception>
+        void AddSessionToGroup(SessionInfo session, ISyncPlayController group);
+
+        /// <summary>
+        /// Unmaps a session from a group.
+        /// </summary>
+        /// <param name="session">The session.</param>
+        /// <param name="group">The group.</param>
+        /// <exception cref="InvalidOperationException"></exception>
+        void RemoveSessionFromGroup(SessionInfo session, ISyncPlayController group);
+    }
+}