From 5cbafa566dab227214f60924332cb0e4bfa75b32 Mon Sep 17 00:00:00 2001 From: mbastian77 Date: Wed, 15 Jul 2026 16:03:56 +0200 Subject: Add XML docs to small session model types and remove CS1591 suppressions --- MediaBrowser.Model/Session/MessageCommand.cs | 13 ++++++++++++- MediaBrowser.Model/Session/PlayMethod.cs | 16 ++++++++++++++-- MediaBrowser.Model/Session/PlaystateRequest.cs | 11 +++++++++-- MediaBrowser.Model/Session/QueueItem.cs | 10 +++++++++- MediaBrowser.Model/Session/RepeatMode.cs | 16 ++++++++++++++-- 5 files changed, 58 insertions(+), 8 deletions(-) (limited to 'MediaBrowser.Model') diff --git a/MediaBrowser.Model/Session/MessageCommand.cs b/MediaBrowser.Model/Session/MessageCommand.cs index cc9db8e6c5..e041a9cccd 100644 --- a/MediaBrowser.Model/Session/MessageCommand.cs +++ b/MediaBrowser.Model/Session/MessageCommand.cs @@ -1,17 +1,28 @@ #nullable disable -#pragma warning disable CS1591 using System.ComponentModel.DataAnnotations; namespace MediaBrowser.Model.Session { + /// + /// A command to display a message on a client. + /// public class MessageCommand { + /// + /// Gets or sets the message header. + /// public string Header { get; set; } + /// + /// Gets or sets the message text. + /// [Required(AllowEmptyStrings = false)] public string Text { get; set; } + /// + /// Gets or sets the timeout in milliseconds after which the message should be dismissed. + /// public long? TimeoutMs { get; set; } } } diff --git a/MediaBrowser.Model/Session/PlayMethod.cs b/MediaBrowser.Model/Session/PlayMethod.cs index 8067627843..2bd11cc91a 100644 --- a/MediaBrowser.Model/Session/PlayMethod.cs +++ b/MediaBrowser.Model/Session/PlayMethod.cs @@ -1,11 +1,23 @@ -#pragma warning disable CS1591 - namespace MediaBrowser.Model.Session { + /// + /// The play method. + /// public enum PlayMethod { + /// + /// The media is transcoded before it is sent to the client. + /// Transcode = 0, + + /// + /// The media is remuxed into a compatible container but the streams are not re-encoded. + /// DirectStream = 1, + + /// + /// The media is sent to the client as-is. + /// DirectPlay = 2 } } diff --git a/MediaBrowser.Model/Session/PlaystateRequest.cs b/MediaBrowser.Model/Session/PlaystateRequest.cs index ba2c024b76..040affa144 100644 --- a/MediaBrowser.Model/Session/PlaystateRequest.cs +++ b/MediaBrowser.Model/Session/PlaystateRequest.cs @@ -1,11 +1,18 @@ -#pragma warning disable CS1591 - namespace MediaBrowser.Model.Session { + /// + /// A request to change the playstate of a session. + /// public class PlaystateRequest { + /// + /// Gets or sets the playstate command. + /// public PlaystateCommand Command { get; set; } + /// + /// Gets or sets the seek position in ticks. + /// public long? SeekPositionTicks { get; set; } /// diff --git a/MediaBrowser.Model/Session/QueueItem.cs b/MediaBrowser.Model/Session/QueueItem.cs index 43920a8464..b9f3181da0 100644 --- a/MediaBrowser.Model/Session/QueueItem.cs +++ b/MediaBrowser.Model/Session/QueueItem.cs @@ -1,13 +1,21 @@ #nullable disable -#pragma warning disable CS1591 using System; namespace MediaBrowser.Model.Session; +/// +/// An item in a play queue. +/// public record QueueItem { + /// + /// Gets or sets the item id. + /// public Guid Id { get; set; } + /// + /// Gets or sets the playlist item id. + /// public string PlaylistItemId { get; set; } } diff --git a/MediaBrowser.Model/Session/RepeatMode.cs b/MediaBrowser.Model/Session/RepeatMode.cs index c6e173d6b8..c6c657d220 100644 --- a/MediaBrowser.Model/Session/RepeatMode.cs +++ b/MediaBrowser.Model/Session/RepeatMode.cs @@ -1,11 +1,23 @@ -#pragma warning disable CS1591 - namespace MediaBrowser.Model.Session { + /// + /// The repeat mode of a play queue. + /// public enum RepeatMode { + /// + /// Nothing is repeated. + /// RepeatNone = 0, + + /// + /// The whole queue is repeated. + /// RepeatAll = 1, + + /// + /// The current item is repeated. + /// RepeatOne = 2 } } -- cgit v1.2.3