MediaBrowser.Controller/Persistence/IKeyframeRepository.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Jellyfin.MediaEncoding.Keyframes;

namespace MediaBrowser.Controller.Persistence;

/// <summary>
/// Provides methods for accessing keyframe data.
/// </summary>
public interface IKeyframeRepository
{
    /// <summary>
    /// Gets the keyframe data.
    /// </summary>
    /// <param name="itemId">The item id.</param>
    /// <returns>The keyframe data.</returns>
    IReadOnlyList<KeyframeData> GetKeyframeData(Guid itemId);

    /// <summary>
    /// Saves the keyframe data.
    /// </summary>
    /// <param name="itemId">The item id.</param>
    /// <param name="data">The keyframe data.</param>
    /// <param name="cancellationToken">The cancellation token.</param>
    /// <returns>The task object representing the asynchronous operation.</returns>
    Task SaveKeyframeDataAsync(Guid itemId, KeyframeData data, CancellationToken cancellationToken);

    /// <summary>
    /// Deletes the keyframe data.
    /// </summary>
    /// <param name="itemId">The item id.</param>
    /// <param name="cancellationToken">The cancellation token.</param>
    /// <returns>The task object representing the asynchronous operation.</returns>
    Task DeleteKeyframeDataAsync(Guid itemId, CancellationToken cancellationToken);
}