From 0d85af019c6ebc855ab2d8e689abe72b995225b4 Mon Sep 17 00:00:00 2001
From: Tim Eisele <Shadowghost@users.noreply.github.com>
Date: Mon, 9 Sep 2024 16:43:37 +0200
Subject: Use enums for encoding options (#12561)

---
 MediaBrowser.Model/Session/TranscodingInfo.cs | 78 ++++++++++++++++++++-------
 1 file changed, 60 insertions(+), 18 deletions(-)

(limited to 'MediaBrowser.Model/Session/TranscodingInfo.cs')

diff --git a/MediaBrowser.Model/Session/TranscodingInfo.cs b/MediaBrowser.Model/Session/TranscodingInfo.cs
index 000cbd4c5..ae25267ac 100644
--- a/MediaBrowser.Model/Session/TranscodingInfo.cs
+++ b/MediaBrowser.Model/Session/TranscodingInfo.cs
@@ -1,34 +1,76 @@
 #nullable disable
-#pragma warning disable CS1591
 
-namespace MediaBrowser.Model.Session
+using MediaBrowser.Model.Entities;
+
+namespace MediaBrowser.Model.Session;
+
+/// <summary>
+/// Class holding information on a runnning transcode.
+/// </summary>
+public class TranscodingInfo
 {
-    public class TranscodingInfo
-    {
-        public string AudioCodec { get; set; }
+    /// <summary>
+    /// Gets or sets the thread count used for encoding.
+    /// </summary>
+    public string AudioCodec { get; set; }
 
-        public string VideoCodec { get; set; }
+    /// <summary>
+    /// Gets or sets the thread count used for encoding.
+    /// </summary>
+    public string VideoCodec { get; set; }
 
-        public string Container { get; set; }
+    /// <summary>
+    /// Gets or sets the thread count used for encoding.
+    /// </summary>
+    public string Container { get; set; }
 
-        public bool IsVideoDirect { get; set; }
+    /// <summary>
+    /// Gets or sets a value indicating whether the video is passed through.
+    /// </summary>
+    public bool IsVideoDirect { get; set; }
 
-        public bool IsAudioDirect { get; set; }
+    /// <summary>
+    /// Gets or sets a value indicating whether the audio is passed through.
+    /// </summary>
+    public bool IsAudioDirect { get; set; }
 
-        public int? Bitrate { get; set; }
+    /// <summary>
+    /// Gets or sets the bitrate.
+    /// </summary>
+    public int? Bitrate { get; set; }
 
-        public float? Framerate { get; set; }
+    /// <summary>
+    /// Gets or sets the framerate.
+    /// </summary>
+    public float? Framerate { get; set; }
 
-        public double? CompletionPercentage { get; set; }
+    /// <summary>
+    /// Gets or sets the completion percentage.
+    /// </summary>
+    public double? CompletionPercentage { get; set; }
 
-        public int? Width { get; set; }
+    /// <summary>
+    /// Gets or sets the video width.
+    /// </summary>
+    public int? Width { get; set; }
 
-        public int? Height { get; set; }
+    /// <summary>
+    /// Gets or sets the video height.
+    /// </summary>
+    public int? Height { get; set; }
 
-        public int? AudioChannels { get; set; }
+    /// <summary>
+    /// Gets or sets the audio channels.
+    /// </summary>
+    public int? AudioChannels { get; set; }
 
-        public HardwareEncodingType? HardwareAccelerationType { get; set; }
+    /// <summary>
+    /// Gets or sets the hardware acceleration type.
+    /// </summary>
+    public HardwareAccelerationType? HardwareAccelerationType { get; set; }
 
-        public TranscodeReason TranscodeReasons { get; set; }
-    }
+    /// <summary>
+    /// Gets or sets the transcode reasons.
+    /// </summary>
+    public TranscodeReason TranscodeReasons { get; set; }
 }
-- 
cgit v1.2.3