src/Jellyfin.MediaEncoding.Hls/Playlist/CreateMainPlaylistRequest.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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

namespace Jellyfin.MediaEncoding.Hls.Playlist
{
    /// <summary>
    /// Request class for the <see cref="IDynamicHlsPlaylistGenerator.CreateMainPlaylist(CreateMainPlaylistRequest)"/> method.
    /// </summary>
    public class CreateMainPlaylistRequest
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="CreateMainPlaylistRequest"/> class.
        /// </summary>
        /// <param name="filePath">The absolute file path to the file.</param>
        /// <param name="desiredSegmentLengthMs">The desired segment length in milliseconds.</param>
        /// <param name="totalRuntimeTicks">The total duration of the file in ticks.</param>
        /// <param name="segmentContainer">The desired segment container eg. "ts".</param>
        /// <param name="endpointPrefix">The URI prefix for the relative URL in the playlist.</param>
        /// <param name="queryString">The desired query string to append (must start with ?).</param>
        public CreateMainPlaylistRequest(string filePath, int desiredSegmentLengthMs, long totalRuntimeTicks, string segmentContainer, string endpointPrefix, string queryString)
        {
            FilePath = filePath;
            DesiredSegmentLengthMs = desiredSegmentLengthMs;
            TotalRuntimeTicks = totalRuntimeTicks;
            SegmentContainer = segmentContainer;
            EndpointPrefix = endpointPrefix;
            QueryString = queryString;
        }

        /// <summary>
        /// Gets the file path.
        /// </summary>
        public string FilePath { get; }

        /// <summary>
        /// Gets the desired segment length in milliseconds.
        /// </summary>
        public int DesiredSegmentLengthMs { get; }

        /// <summary>
        /// Gets the total runtime in ticks.
        /// </summary>
        public long TotalRuntimeTicks { get; }

        /// <summary>
        /// Gets the segment container.
        /// </summary>
        public string SegmentContainer { get; }

        /// <summary>
        /// Gets the endpoint prefix for the URL.
        /// </summary>
        public string EndpointPrefix { get; }

        /// <summary>
        /// Gets the query string.
        /// </summary>
        public string QueryString { get; }
    }
}