From d96d1f111994104c7672e2f64f64a92902458f41 Mon Sep 17 00:00:00 2001 From: mbastian77 Date: Wed, 15 Jul 2026 12:11:11 +0200 Subject: Add XML docs to small DLNA model types and remove CS1591 suppressions --- MediaBrowser.Model/Dlna/CodecType.cs | 16 ++++++++++++++-- MediaBrowser.Model/Dlna/EncodingContext.cs | 12 ++++++++++-- MediaBrowser.Model/Dlna/PlaybackErrorCode.cs | 16 ++++++++++++++-- MediaBrowser.Model/Dlna/ResolutionOptions.cs | 11 +++++++++-- MediaBrowser.Model/Dlna/TranscodeSeekInfo.cs | 12 ++++++++++-- 5 files changed, 57 insertions(+), 10 deletions(-) diff --git a/MediaBrowser.Model/Dlna/CodecType.cs b/MediaBrowser.Model/Dlna/CodecType.cs index c9f090e4cc..12730a76fa 100644 --- a/MediaBrowser.Model/Dlna/CodecType.cs +++ b/MediaBrowser.Model/Dlna/CodecType.cs @@ -1,11 +1,23 @@ -#pragma warning disable CS1591 - namespace MediaBrowser.Model.Dlna { + /// + /// The codec type of a codec profile. + /// public enum CodecType { + /// + /// The profile applies to a video codec. + /// Video = 0, + + /// + /// The profile applies to the audio codec of a video stream. + /// VideoAudio = 1, + + /// + /// The profile applies to an audio codec. + /// Audio = 2 } } diff --git a/MediaBrowser.Model/Dlna/EncodingContext.cs b/MediaBrowser.Model/Dlna/EncodingContext.cs index 79ca6366d7..1408333d2e 100644 --- a/MediaBrowser.Model/Dlna/EncodingContext.cs +++ b/MediaBrowser.Model/Dlna/EncodingContext.cs @@ -1,10 +1,18 @@ -#pragma warning disable CS1591 - namespace MediaBrowser.Model.Dlna { + /// + /// The encoding context. + /// public enum EncodingContext { + /// + /// The media is transcoded on the fly and delivered as a stream. + /// Streaming = 0, + + /// + /// The media is transcoded to a static file. + /// Static = 1 } } diff --git a/MediaBrowser.Model/Dlna/PlaybackErrorCode.cs b/MediaBrowser.Model/Dlna/PlaybackErrorCode.cs index 300fab5c50..a28f422a2b 100644 --- a/MediaBrowser.Model/Dlna/PlaybackErrorCode.cs +++ b/MediaBrowser.Model/Dlna/PlaybackErrorCode.cs @@ -1,11 +1,23 @@ -#pragma warning disable CS1591 - namespace MediaBrowser.Model.Dlna { + /// + /// The playback error code. + /// public enum PlaybackErrorCode { + /// + /// Playback of the item is not allowed. + /// NotAllowed = 0, + + /// + /// No stream compatible with the device profile was found. + /// NoCompatibleStream = 1, + + /// + /// The rate limit has been exceeded. + /// RateLimitExceeded = 2 } } diff --git a/MediaBrowser.Model/Dlna/ResolutionOptions.cs b/MediaBrowser.Model/Dlna/ResolutionOptions.cs index 774592abc7..b161b4a1e4 100644 --- a/MediaBrowser.Model/Dlna/ResolutionOptions.cs +++ b/MediaBrowser.Model/Dlna/ResolutionOptions.cs @@ -1,11 +1,18 @@ -#pragma warning disable CS1591 - namespace MediaBrowser.Model.Dlna { + /// + /// The resolution constraints. + /// public class ResolutionOptions { + /// + /// Gets or sets the maximum width. + /// public int? MaxWidth { get; set; } + /// + /// Gets or sets the maximum height. + /// public int? MaxHeight { get; set; } } } diff --git a/MediaBrowser.Model/Dlna/TranscodeSeekInfo.cs b/MediaBrowser.Model/Dlna/TranscodeSeekInfo.cs index cc0c6069bf..1563ffd17a 100644 --- a/MediaBrowser.Model/Dlna/TranscodeSeekInfo.cs +++ b/MediaBrowser.Model/Dlna/TranscodeSeekInfo.cs @@ -1,10 +1,18 @@ -#pragma warning disable CS1591 - namespace MediaBrowser.Model.Dlna { + /// + /// The transcode seek info. + /// public enum TranscodeSeekInfo { + /// + /// The seek method is chosen automatically. + /// Auto = 0, + + /// + /// Seeking is performed by byte position. + /// Bytes = 1 } } -- cgit v1.2.3