aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/Trickplay
diff options
context:
space:
mode:
authorNick <20588554+nicknsy@users.noreply.github.com>2023-05-01 12:51:05 -0700
committerNick <20588554+nicknsy@users.noreply.github.com>2023-06-22 16:23:52 -0700
commit33770322282326304b4b8073f583d6fed2354c0b (patch)
tree1dae2889dca28f9dc960b4aea634cb83d1c86729 /MediaBrowser.Controller/Trickplay
parentdd8ef08592830236b31307e2424b491e974f024a (diff)
crobibero styling, format, code suggestions
Diffstat (limited to 'MediaBrowser.Controller/Trickplay')
-rw-r--r--MediaBrowser.Controller/Trickplay/ITrickplayManager.cs77
1 files changed, 38 insertions, 39 deletions
diff --git a/MediaBrowser.Controller/Trickplay/ITrickplayManager.cs b/MediaBrowser.Controller/Trickplay/ITrickplayManager.cs
index bae458f98..8e82c57d4 100644
--- a/MediaBrowser.Controller/Trickplay/ITrickplayManager.cs
+++ b/MediaBrowser.Controller/Trickplay/ITrickplayManager.cs
@@ -5,50 +5,49 @@ using System.Threading.Tasks;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Model.Entities;
-namespace MediaBrowser.Controller.Trickplay
+namespace MediaBrowser.Controller.Trickplay;
+
+/// <summary>
+/// Interface ITrickplayManager.
+/// </summary>
+public interface ITrickplayManager
{
/// <summary>
- /// Interface ITrickplayManager.
+ /// Generate or replace trickplay data.
/// </summary>
- public interface ITrickplayManager
- {
- /// <summary>
- /// Generate or replace trickplay data.
- /// </summary>
- /// <param name="video">The video.</param>
- /// <param name="replace">Whether or not existing data should be replaced.</param>
- /// <param name="cancellationToken">CancellationToken to use for operation.</param>
- /// <returns>Task.</returns>
- Task RefreshTrickplayData(Video video, bool replace, CancellationToken cancellationToken);
+ /// <param name="video">The video.</param>
+ /// <param name="replace">Whether or not existing data should be replaced.</param>
+ /// <param name="cancellationToken">CancellationToken to use for operation.</param>
+ /// <returns>Task.</returns>
+ Task RefreshTrickplayDataAsync(Video video, bool replace, CancellationToken cancellationToken);
- /// <summary>
- /// Get available trickplay resolutions and corresponding info.
- /// </summary>
- /// <param name="itemId">The item.</param>
- /// <returns>Map of width resolutions to trickplay tiles info.</returns>
- Dictionary<int, TrickplayTilesInfo> GetTilesResolutions(Guid itemId);
+ /// <summary>
+ /// Get available trickplay resolutions and corresponding info.
+ /// </summary>
+ /// <param name="itemId">The item.</param>
+ /// <returns>Map of width resolutions to trickplay tiles info.</returns>
+ Dictionary<int, TrickplayTilesInfo> GetTilesResolutions(Guid itemId);
- /// <summary>
- /// Saves trickplay tiles info.
- /// </summary>
- /// <param name="itemId">The item.</param>
- /// <param name="tilesInfo">The trickplay tiles info.</param>
- void SaveTilesInfo(Guid itemId, TrickplayTilesInfo tilesInfo);
+ /// <summary>
+ /// Saves trickplay tiles info.
+ /// </summary>
+ /// <param name="itemId">The item.</param>
+ /// <param name="tilesInfo">The trickplay tiles info.</param>
+ void SaveTilesInfo(Guid itemId, TrickplayTilesInfo tilesInfo);
- /// <summary>
- /// Gets the trickplay manifest.
- /// </summary>
- /// <param name="item">The item.</param>
- /// <returns>A map of media source id to a map of tile width to tile info.</returns>
- Dictionary<Guid, Dictionary<int, TrickplayTilesInfo>> GetTrickplayManifest(BaseItem item);
+ /// <summary>
+ /// Gets the trickplay manifest.
+ /// </summary>
+ /// <param name="item">The item.</param>
+ /// <returns>A map of media source id to a map of tile width to tile info.</returns>
+ Dictionary<Guid, Dictionary<int, TrickplayTilesInfo>> GetTrickplayManifest(BaseItem item);
- /// <summary>
- /// Gets the path to a trickplay tiles image.
- /// </summary>
- /// <param name="item">The item.</param>
- /// <param name="width">The width of a single tile.</param>
- /// <param name="index">The tile grid's index.</param>
- /// <returns>The absolute path.</returns>
- string GetTrickplayTilePath(BaseItem item, int width, int index);
- }
+ /// <summary>
+ /// Gets the path to a trickplay tiles image.
+ /// </summary>
+ /// <param name="item">The item.</param>
+ /// <param name="width">The width of a single tile.</param>
+ /// <param name="index">The tile grid's index.</param>
+ /// <returns>The absolute path.</returns>
+ string GetTrickplayTilePath(BaseItem item, int width, int index);
}