aboutsummaryrefslogtreecommitdiff
path: root/RSSDP/SsdpDeviceIcon.cs
blob: 3ed707c80aa03bb458da88c76418a533f95f2e33 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;

namespace Rssdp
{
	/// <summary>
	/// Represents an icon published by an <see cref="SsdpDevice"/>.
	/// </summary>
	public sealed class SsdpDeviceIcon
	{
		/// <summary>
		/// The mime type for the image data returned by the <see cref="Url"/> property.
		/// </summary>
		/// <remarks>
		/// <para>Required. Icon's MIME type (cf. RFC 2045, 2046, and 2387). Single MIME image type. At least one icon should be of type “image/png” (Portable Network Graphics, see IETF RFC 2083).</para> 
		/// </remarks>
		/// <seealso cref="Url"/>
		public string MimeType { get; set; }

		/// <summary>
		/// The URL that can be called with an HTTP GET command to retrieve the image data.
		/// </summary>
		/// <remarks>
		/// <para>Required. May be relative to base URL. Specified by UPnP vendor. Single URL.</para>
		/// </remarks>
		/// <seealso cref="MimeType"/>
		public Uri Url { get; set; }
			
		/// <summary>
		/// The width of the image in pixels.
		/// </summary>
		/// <remarks><para>Required, must be greater than zero.</para></remarks>
		public int Width { get; set; }

		/// <summary>
		/// The height of the image in pixels.
		/// </summary>
		/// <remarks><para>Required, must be greater than zero.</para></remarks>
		public int Height { get; set; }

		/// <summary>
		/// The colour depth of the image.
		/// </summary>
		/// <remarks><para>Required, must be greater than zero.</para></remarks>
		public int ColorDepth { get; set; }

	}
}