jellyfin/Emby.Dlna/Configuration/DlnaOptions.cs

#pragma warning disable CS1591

namespace Emby.Dlna.Configuration
{
    /// <summary>
    /// The DlnaOptions class contains the user definable parameters for the dlna subsystems.
    /// </summary>
    public class DlnaOptions
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="DlnaOptions"/> class.
        /// </summary>
        public DlnaOptions()
        {
            EnablePlayTo = true;
            EnableServer = false;
            BlastAliveMessages = true;
            SendOnlyMatchedHost = true;
            ClientDiscoveryIntervalSeconds = 60;
            AliveMessageIntervalSeconds = 1800;
        }

        /// <summary>
        /// Gets or sets a value indicating whether gets or sets a value to indicate the status of the dlna playTo subsystem.
        /// </summary>
        public bool EnablePlayTo { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether gets or sets a value to indicate the status of the dlna server subsystem.
        /// </summary>
        public bool EnableServer { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether detailed dlna server logs are sent to the console/log.
        /// If the setting "Emby.Dlna": "Debug" msut be set in logging.default.json for this property to work.
        /// </summary>
        public bool EnableDebugLog { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether whether detailed playTo debug logs are sent to the console/log.
        /// If the setting "Emby.Dlna.PlayTo": "Debug" msut be set in logging.default.json for this property to work.
        /// </summary>
        public bool EnablePlayToTracing { get; set; }

        /// <summary>
        /// Gets or sets the ssdp client discovery interval time (in seconds).
        /// This is the time after which the server will send a ssdp search request.
        /// </summary>
        public int ClientDiscoveryIntervalSeconds { get; set; }

        /// <summary>
        /// Gets or sets the frequency at which ssdp alive notifications are transmitted.
        /// </summary>
        public int AliveMessageIntervalSeconds { get; set; }

        /// <summary>
        /// Gets or sets the frequency at which ssdp alive notifications are transmitted. MIGRATING - TO BE REMOVED ONCE WEB HAS BEEN ALTERED.
        /// </summary>
        public int BlastAliveMessageIntervalSeconds
        {
            get
            {
                return AliveMessageIntervalSeconds;
            }

            set
            {
                AliveMessageIntervalSeconds = value;
            }
        }

        /// <summary>
        /// Gets or sets the default user account that the dlna server uses.
        /// </summary>
        public string? DefaultUserId { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether playTo device profiles should be created.
        /// </summary>
        public bool AutoCreatePlayToProfiles { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether to blast alive messages.
        /// </summary>
        public bool BlastAliveMessages { get; set; } = true;

        /// <summary>
        /// gets or sets a value indicating whether to send only matched host.
        /// </summary>
        public bool SendOnlyMatchedHost { get; set; } = true;
    }
}