aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller
diff options
context:
space:
mode:
authorIonut Andrei Oanca <oancaionutandrei@gmail.com>2020-10-21 16:42:57 +0200
committerIonut Andrei Oanca <oancaionutandrei@gmail.com>2020-10-21 16:42:57 +0200
commit36fee4e60a033d8d785e62788aaf00999d497c58 (patch)
treed027211df6ba4f4991967831d38eccb954a4365b /MediaBrowser.Controller
parent93cbf64f884688b667c5403412cb8193dadb251c (diff)
Minor fixes
Diffstat (limited to 'MediaBrowser.Controller')
-rw-r--r--MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs2
-rw-r--r--MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs2
-rw-r--r--MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs4
-rw-r--r--MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs18
-rw-r--r--MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs6
-rw-r--r--MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs6
-rw-r--r--MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs4
-rw-r--r--MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs2
-rw-r--r--MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs4
-rw-r--r--MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs6
-rw-r--r--MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs6
-rw-r--r--MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs4
-rw-r--r--MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs26
13 files changed, 45 insertions, 45 deletions
diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs
index 9a4e1ee1e..2f497ebbb 100644
--- a/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs
+++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs
@@ -26,7 +26,7 @@ namespace MediaBrowser.Controller.SyncPlay
/// <summary>
/// Checks if the group is empty.
/// </summary>
- /// <returns>If the group is empty.</returns>
+ /// <returns><c>true</c> if the group is empty, <c>false</c> otherwise</returns>
bool IsGroupEmpty();
/// <summary>
diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs
index ae2b0fa50..ec13686c6 100644
--- a/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs
+++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs
@@ -23,7 +23,7 @@ namespace MediaBrowser.Controller.SyncPlay
/// Adds the session to a group.
/// </summary>
/// <param name="session">The session.</param>
- /// <param name="groupId">The group id.</param>
+ /// <param name="groupId">The group identifier.</param>
/// <param name="request">The request.</param>
/// <param name="cancellationToken">The cancellation token.</param>
void JoinGroup(SessionInfo session, Guid groupId, JoinGroupRequest request, CancellationToken cancellationToken);
diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs
index 290576e30..218e871e3 100644
--- a/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs
+++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs
@@ -16,7 +16,7 @@ namespace MediaBrowser.Controller.SyncPlay
GroupState GetGroupState();
/// <summary>
- /// Handle a session that joined the group.
+ /// Handles a session that joined the group.
/// </summary>
/// <param name="context">The context of the state.</param>
/// <param name="prevState">The previous state.</param>
@@ -25,7 +25,7 @@ namespace MediaBrowser.Controller.SyncPlay
void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken);
/// <summary>
- /// Handle a session that is leaving the group.
+ /// Handles a session that is leaving the group.
/// </summary>
/// <param name="context">The context of the state.</param>
/// <param name="prevState">The previous state.</param>
diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs
index 18a685749..13d38a02b 100644
--- a/MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs
+++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs
@@ -71,7 +71,7 @@ namespace MediaBrowser.Controller.SyncPlay
/// Builds a new playback command with some default values.
/// </summary>
/// <param name="type">The command type.</param>
- /// <returns>The SendCommand.</returns>
+ /// <returns>The command.</returns>
SendCommand NewSyncPlayCommand(SendCommandType type);
/// <summary>
@@ -79,7 +79,7 @@ namespace MediaBrowser.Controller.SyncPlay
/// </summary>
/// <param name="type">The update type.</param>
/// <param name="data">The data to send.</param>
- /// <returns>The GroupUpdate.</returns>
+ /// <returns>The group update.</returns>
GroupUpdate<T> NewSyncPlayGroupUpdate<T>(GroupUpdateType type, T data);
/// <summary>
@@ -93,7 +93,7 @@ namespace MediaBrowser.Controller.SyncPlay
/// Sanitizes the PositionTicks, considers the current playing item when available.
/// </summary>
/// <param name="positionTicks">The PositionTicks.</param>
- /// <returns>The sanitized PositionTicks.</returns>
+ /// <returns>The sanitized position ticks.</returns>
long SanitizePositionTicks(long? positionTicks);
/// <summary>
@@ -141,14 +141,14 @@ namespace MediaBrowser.Controller.SyncPlay
/// <param name="playQueue">The new play queue.</param>
/// <param name="playingItemPosition">The playing item position in the play queue.</param>
/// <param name="startPositionTicks">The start position ticks.</param>
- /// <returns><c>true</c> if the play queue has been changed; <c>false</c> is something went wrong.</returns>
+ /// <returns><c>true</c> if the play queue has been changed; <c>false</c> if something went wrong.</returns>
bool SetPlayQueue(Guid[] playQueue, int playingItemPosition, long startPositionTicks);
/// <summary>
/// Sets the playing item.
/// </summary>
- /// <param name="playlistItemId">The new playing item id.</param>
- /// <returns><c>true</c> if the play queue has been changed; <c>false</c> is something went wrong.</returns>
+ /// <param name="playlistItemId">The new playing item identifier.</param>
+ /// <returns><c>true</c> if the play queue has been changed; <c>false</c> if something went wrong.</returns>
bool SetPlayingItem(string playlistItemId);
/// <summary>
@@ -161,9 +161,9 @@ namespace MediaBrowser.Controller.SyncPlay
/// <summary>
/// Moves an item in the play queue.
/// </summary>
- /// <param name="playlistItemId">The playlist id of the item to move.</param>
+ /// <param name="playlistItemId">The playlist identifier of the item to move.</param>
/// <param name="newIndex">The new position.</param>
- /// <returns><c>true</c> if item has been moved; <c>false</c> is something went wrong.</returns>
+ /// <returns><c>true</c> if item has been moved; <c>false</c> if something went wrong.</returns>
bool MoveItemInPlayQueue(string playlistItemId, int newIndex);
/// <summary>
@@ -171,7 +171,7 @@ namespace MediaBrowser.Controller.SyncPlay
/// </summary>
/// <param name="newItems">The new items to add to the play queue.</param>
/// <param name="mode">The mode with which the items will be added.</param>
- /// <returns><c>true</c> if the play queue has been changed; <c>false</c> is something went wrong.</returns>
+ /// <returns><c>true</c> if the play queue has been changed; <c>false</c> if something went wrong.</returns>
bool AddToPlayQueue(Guid[] newItems, string mode);
/// <summary>
diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs
index 0815dd79b..65fced43f 100644
--- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs
+++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs
@@ -6,7 +6,7 @@ using MediaBrowser.Controller.Session;
namespace MediaBrowser.Controller.SyncPlay
{
/// <summary>
- /// Class BufferingGroupRequest.
+ /// Class BufferGroupRequest.
/// </summary>
public class BufferGroupRequest : IPlaybackGroupRequest
{
@@ -29,9 +29,9 @@ namespace MediaBrowser.Controller.SyncPlay
public bool IsPlaying { get; set; }
/// <summary>
- /// Gets or sets the playlist item id of the playing item.
+ /// Gets or sets the playlist item identifier of the playing item.
/// </summary>
- /// <value>The playlist item id.</value>
+ /// <value>The playlist item identifier.</value>
public string PlaylistItemId { get; set; }
/// <inheritdoc />
diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs
index 7a293c02f..38170facf 100644
--- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs
+++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs
@@ -10,9 +10,9 @@ namespace MediaBrowser.Controller.SyncPlay
public class MovePlaylistItemGroupRequest : IPlaybackGroupRequest
{
/// <summary>
- /// Gets or sets the playlist id of the item.
+ /// Gets or sets the playlist identifier of the item.
/// </summary>
- /// <value>The playlist id of the item.</value>
+ /// <value>The playlist identifier of the item.</value>
public string PlaylistItemId { get; set; }
/// <summary>
@@ -24,7 +24,7 @@ namespace MediaBrowser.Controller.SyncPlay
/// <inheritdoc />
public PlaybackRequestType GetRequestType()
{
- return PlaybackRequestType.Queue;
+ return PlaybackRequestType.MovePlaylistItem;
}
/// <inheritdoc />
diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs
index d19df2c6a..b27c10f16 100644
--- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs
+++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs
@@ -10,9 +10,9 @@ namespace MediaBrowser.Controller.SyncPlay
public class NextTrackGroupRequest : IPlaybackGroupRequest
{
/// <summary>
- /// Gets or sets the playing item id.
+ /// Gets or sets the playing item identifier.
/// </summary>
- /// <value>The playing item id.</value>
+ /// <value>The playing item identifier.</value>
public string PlaylistItemId { get; set; }
/// <inheritdoc />
diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs
index 631bf245b..5605578d7 100644
--- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs
+++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs
@@ -5,7 +5,7 @@ using MediaBrowser.Controller.Session;
namespace MediaBrowser.Controller.SyncPlay
{
/// <summary>
- /// Class UpdatePingGroupRequest.
+ /// Class PingGroupRequest.
/// </summary>
public class PingGroupRequest : IPlaybackGroupRequest
{
diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs
index 663011b42..31b93b967 100644
--- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs
+++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs
@@ -10,9 +10,9 @@ namespace MediaBrowser.Controller.SyncPlay
public class PreviousTrackGroupRequest : IPlaybackGroupRequest
{
/// <summary>
- /// Gets or sets the playing item id.
+ /// Gets or sets the playing item identifier.
/// </summary>
- /// <value>The playing item id.</value>
+ /// <value>The playing item identifier.</value>
public string PlaylistItemId { get; set; }
/// <inheritdoc />
diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs
index 16bc67c61..8f266ed32 100644
--- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs
+++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs
@@ -6,7 +6,7 @@ using MediaBrowser.Controller.Session;
namespace MediaBrowser.Controller.SyncPlay
{
/// <summary>
- /// Class BufferingDoneGroupRequest.
+ /// Class ReadyGroupRequest.
/// </summary>
public class ReadyGroupRequest : IPlaybackGroupRequest
{
@@ -29,9 +29,9 @@ namespace MediaBrowser.Controller.SyncPlay
public bool IsPlaying { get; set; }
/// <summary>
- /// Gets or sets the playlist item id of the playing item.
+ /// Gets or sets the playlist item identifier of the playing item.
/// </summary>
- /// <value>The playlist item id.</value>
+ /// <value>The playlist item identifier.</value>
public string PlaylistItemId { get; set; }
/// <inheritdoc />
diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs
index 3fc77f677..78aeb9c6f 100644
--- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs
+++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs
@@ -10,15 +10,15 @@ namespace MediaBrowser.Controller.SyncPlay
public class RemoveFromPlaylistGroupRequest : IPlaybackGroupRequest
{
/// <summary>
- /// Gets or sets the playlist ids ot the items.
+ /// Gets or sets the playlist identifiers ot the items.
/// </summary>
- /// <value>The playlist ids ot the items.</value>
+ /// <value>The playlist identifiers ot the items.</value>
public string[] PlaylistItemIds { get; set; }
/// <inheritdoc />
public PlaybackRequestType GetRequestType()
{
- return PlaybackRequestType.Queue;
+ return PlaybackRequestType.RemoveFromPlaylist;
}
/// <inheritdoc />
diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs
index d70559899..070fd71d2 100644
--- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs
+++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs
@@ -10,9 +10,9 @@ namespace MediaBrowser.Controller.SyncPlay
public class SetPlaylistItemGroupRequest : IPlaybackGroupRequest
{
/// <summary>
- /// Gets or sets the playlist id of the playing item.
+ /// Gets or sets the playlist identifier of the playing item.
/// </summary>
- /// <value>The playlist id of the playing item.</value>
+ /// <value>The playlist identifier of the playing item.</value>
public string PlaylistItemId { get; set; }
/// <inheritdoc />
diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs
index 6b4f9401e..aca50f80a 100644
--- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs
+++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs
@@ -64,9 +64,9 @@ namespace MediaBrowser.Controller.SyncPlay
public GroupRepeatMode RepeatMode { get; private set; } = GroupRepeatMode.RepeatNone;
/// <summary>
- /// Gets or sets the progressive id counter.
+ /// Gets or sets the progressive identifier counter.
/// </summary>
- /// <value>The progressive id.</value>
+ /// <value>The progressive identifier.</value>
private int ProgressiveId { get; set; } = 0;
private bool _disposed = false;
@@ -101,15 +101,15 @@ namespace MediaBrowser.Controller.SyncPlay
}
/// <summary>
- /// Gets the next available id.
+ /// Gets the next available identifier.
/// </summary>
- /// <returns>The next available id.</returns>
+ /// <returns>The next available identifier.</returns>
private int GetNextProgressiveId() {
return ProgressiveId++;
}
/// <summary>
- /// Creates a list from the array of items. Each item is given an unique playlist id.
+ /// Creates a list from the array of items. Each item is given an unique playlist identifier.
/// </summary>
/// <returns>The list of queue items.</returns>
private List<QueueItem> CreateQueueItemsFromArray(Guid[] items)
@@ -276,9 +276,9 @@ namespace MediaBrowser.Controller.SyncPlay
}
/// <summary>
- /// Gets playlist id of the playing item, if any.
+ /// Gets playlist identifier of the playing item, if any.
/// </summary>
- /// <returns>The playlist id of the playing item.</returns>
+ /// <returns>The playlist identifier of the playing item.</returns>
public string GetPlayingItemPlaylistId()
{
if (PlayingItemIndex < 0)
@@ -299,9 +299,9 @@ namespace MediaBrowser.Controller.SyncPlay
}
/// <summary>
- /// Gets the playing item id, if any.
+ /// Gets the playing item identifier, if any.
/// </summary>
- /// <returns>The playing item id.</returns>
+ /// <returns>The playing item identifier.</returns>
public Guid GetPlayingItemId()
{
if (PlayingItemIndex < 0)
@@ -322,9 +322,9 @@ namespace MediaBrowser.Controller.SyncPlay
}
/// <summary>
- /// Sets the playing item using its id. If not in the playlist, the playing item is reset.
+ /// Sets the playing item using its identifier. If not in the playlist, the playing item is reset.
/// </summary>
- /// <param name="itemId">The new playing item id.</param>
+ /// <param name="itemId">The new playing item identifier.</param>
public void SetPlayingItemById(Guid itemId)
{
var itemIds = GetPlaylistAsList().Select(queueItem => queueItem.ItemId).ToList();
@@ -333,9 +333,9 @@ namespace MediaBrowser.Controller.SyncPlay
}
/// <summary>
- /// Sets the playing item using its playlist id. If not in the playlist, the playing item is reset.
+ /// Sets the playing item using its playlist identifier. If not in the playlist, the playing item is reset.
/// </summary>
- /// <param name="playlistItemId">The new playing item id.</param>
+ /// <param name="playlistItemId">The new playing item identifier.</param>
/// <returns><c>true</c> if playing item has been set; <c>false</c> if item is not in the playlist.</returns>
public bool SetPlayingItemByPlaylistId(string playlistItemId)
{