Merge pull request #6600 from cvium/keyframe_extraction_v1

1 files changed, 24 insertions, 0 deletions

diff --git a/src/Jellyfin.MediaEncoding.Hls/Extractors/IKeyframeExtractor.cs b/src/Jellyfin.MediaEncoding.Hls/Extractors/IKeyframeExtractor.cs
new file mode 100644
index 000000000..497210f41
--- /dev/null
+++ b/src/Jellyfin.MediaEncoding.Hls/Extractors/IKeyframeExtractor.cs
@@ -0,0 +1,24 @@
+using System;
+using System.Diagnostics.CodeAnalysis;
+using Jellyfin.MediaEncoding.Keyframes;
+
+namespace Jellyfin.MediaEncoding.Hls.Extractors;
+
+/// <summary>
+/// Keyframe extractor.
+/// </summary>
+public interface IKeyframeExtractor
+{
+    /// <summary>
+    /// Gets a value indicating whether the extractor is based on container metadata.
+    /// </summary>
+    bool IsMetadataBased { get; }
+
+    /// <summary>
+    /// Attempt to extract keyframes.
+    /// </summary>
+    /// <param name="filePath">The path to the file.</param>
+    /// <param name="keyframeData">The keyframes.</param>
+    /// <returns>A value indicating whether the keyframe extraction was successful.</returns>
+    bool TryExtractKeyframes(string filePath, [NotNullWhen(true)] out KeyframeData? keyframeData);
+}