aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Data/Enums/SubtitlePlaybackMode.cs
diff options
context:
space:
mode:
authorPatrick Barron <barronpm@gmail.com>2020-08-31 23:17:33 -0400
committerPatrick Barron <barronpm@gmail.com>2020-08-31 23:17:33 -0400
commit65bce98ec535feddc8fded5907734d0858781674 (patch)
tree2003d0e417c58ae1862de0f3f9359821d171a9dc /Jellyfin.Data/Enums/SubtitlePlaybackMode.cs
parent0110b2472de572ae5b2322adaa1fa73325793e02 (diff)
Document SubtitlePlaybackMode.cs
Diffstat (limited to 'Jellyfin.Data/Enums/SubtitlePlaybackMode.cs')
-rw-r--r--Jellyfin.Data/Enums/SubtitlePlaybackMode.cs26
1 files changed, 23 insertions, 3 deletions
diff --git a/Jellyfin.Data/Enums/SubtitlePlaybackMode.cs b/Jellyfin.Data/Enums/SubtitlePlaybackMode.cs
index c8fc21159..ca41300ed 100644
--- a/Jellyfin.Data/Enums/SubtitlePlaybackMode.cs
+++ b/Jellyfin.Data/Enums/SubtitlePlaybackMode.cs
@@ -1,13 +1,33 @@
-#pragma warning disable CS1591
-
-namespace Jellyfin.Data.Enums
+namespace Jellyfin.Data.Enums
{
+ /// <summary>
+ /// An enum representing a subtitle playback mode.
+ /// </summary>
public enum SubtitlePlaybackMode
{
+ /// <summary>
+ /// The default subtitle playback mode.
+ /// </summary>
Default = 0,
+
+ /// <summary>
+ /// Always show subtitles.
+ /// </summary>
Always = 1,
+
+ /// <summary>
+ /// Only show forced subtitles.
+ /// </summary>
OnlyForced = 2,
+
+ /// <summary>
+ /// Don't show subtitles.
+ /// </summary>
None = 3,
+
+ /// <summary>
+ /// Only show subtitles when the current audio stream is in a different language.
+ /// </summary>
Smart = 4
}
}