mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-09-07 03:48:06 +02:00
Merge pull request #5941 from Maxr1998/device-profile-docs
Improve documentation for DeviceProfile
This commit is contained in:
commit
df40828e1f
1 changed files with 23 additions and 18 deletions
|
@ -8,13 +8,18 @@ using MediaBrowser.Model.MediaInfo;
|
||||||
namespace MediaBrowser.Model.Dlna
|
namespace MediaBrowser.Model.Dlna
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Defines the <see cref="DeviceProfile" />.
|
/// A <see cref="DeviceProfile" /> represents a set of metadata which determines which content a certain device is able to play.
|
||||||
|
/// <br/>
|
||||||
|
/// Specifically, it defines the supported <see cref="ContainerProfiles">containers</see> and
|
||||||
|
/// <see cref="CodecProfiles">codecs</see> (video and/or audio, including codec profiles and levels)
|
||||||
|
/// the device is able to direct play (without transcoding or remuxing),
|
||||||
|
/// as well as which <see cref="TranscodingProfiles">containers/codecs to transcode to</see> in case it isn't.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[XmlRoot("Profile")]
|
[XmlRoot("Profile")]
|
||||||
public class DeviceProfile
|
public class DeviceProfile
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the Name.
|
/// Gets or sets the name of this device profile.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string? Name { get; set; }
|
public string? Name { get; set; }
|
||||||
|
|
||||||
|
@ -30,32 +35,32 @@ namespace MediaBrowser.Model.Dlna
|
||||||
public DeviceIdentification? Identification { get; set; }
|
public DeviceIdentification? Identification { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the FriendlyName.
|
/// Gets or sets the friendly name of the device profile, which can be shown to users.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string? FriendlyName { get; set; }
|
public string? FriendlyName { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the Manufacturer.
|
/// Gets or sets the manufacturer of the device which this profile represents.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string? Manufacturer { get; set; }
|
public string? Manufacturer { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the ManufacturerUrl.
|
/// Gets or sets an url for the manufacturer of the device which this profile represents.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string? ManufacturerUrl { get; set; }
|
public string? ManufacturerUrl { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the ModelName.
|
/// Gets or sets the model name of the device which this profile represents.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string? ModelName { get; set; }
|
public string? ModelName { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the ModelDescription.
|
/// Gets or sets the model description of the device which this profile represents.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string? ModelDescription { get; set; }
|
public string? ModelDescription { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the ModelNumber.
|
/// Gets or sets the model number of the device which this profile represents.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string? ModelNumber { get; set; }
|
public string? ModelNumber { get; set; }
|
||||||
|
|
||||||
|
@ -65,7 +70,7 @@ namespace MediaBrowser.Model.Dlna
|
||||||
public string? ModelUrl { get; set; }
|
public string? ModelUrl { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the SerialNumber.
|
/// Gets or sets the serial number of the device which this profile represents.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string? SerialNumber { get; set; }
|
public string? SerialNumber { get; set; }
|
||||||
|
|
||||||
|
@ -113,32 +118,32 @@ namespace MediaBrowser.Model.Dlna
|
||||||
public int? MaxAlbumArtHeight { get; set; }
|
public int? MaxAlbumArtHeight { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the MaxIconWidth.
|
/// Gets or sets the maximum allowed width of embedded icons.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int? MaxIconWidth { get; set; }
|
public int? MaxIconWidth { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the MaxIconHeight.
|
/// Gets or sets the maximum allowed height of embedded icons.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int? MaxIconHeight { get; set; }
|
public int? MaxIconHeight { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the MaxStreamingBitrate.
|
/// Gets or sets the maximum allowed bitrate for all streamed content.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int? MaxStreamingBitrate { get; set; } = 8000000;
|
public int? MaxStreamingBitrate { get; set; } = 8000000;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the MaxStaticBitrate.
|
/// Gets or sets the maximum allowed bitrate for statically streamed content (= direct played files).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int? MaxStaticBitrate { get; set; } = 8000000;
|
public int? MaxStaticBitrate { get; set; } = 8000000;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the MusicStreamingTranscodingBitrate.
|
/// Gets or sets the maximum allowed bitrate for transcoded music streams.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int? MusicStreamingTranscodingBitrate { get; set; } = 128000;
|
public int? MusicStreamingTranscodingBitrate { get; set; } = 128000;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the MaxStaticMusicBitrate.
|
/// Gets or sets the maximum allowed bitrate for statically streamed (= direct played) music files.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public int? MaxStaticMusicBitrate { get; set; } = 8000000;
|
public int? MaxStaticMusicBitrate { get; set; } = 8000000;
|
||||||
|
|
||||||
|
@ -198,12 +203,12 @@ namespace MediaBrowser.Model.Dlna
|
||||||
public TranscodingProfile[] TranscodingProfiles { get; set; } = Array.Empty<TranscodingProfile>();
|
public TranscodingProfile[] TranscodingProfiles { get; set; } = Array.Empty<TranscodingProfile>();
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the ContainerProfiles.
|
/// Gets or sets the container profiles.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public ContainerProfile[] ContainerProfiles { get; set; } = Array.Empty<ContainerProfile>();
|
public ContainerProfile[] ContainerProfiles { get; set; } = Array.Empty<ContainerProfile>();
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the CodecProfiles.
|
/// Gets or sets the codec profiles.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public CodecProfile[] CodecProfiles { get; set; } = Array.Empty<CodecProfile>();
|
public CodecProfile[] CodecProfiles { get; set; } = Array.Empty<CodecProfile>();
|
||||||
|
|
||||||
|
@ -213,7 +218,7 @@ namespace MediaBrowser.Model.Dlna
|
||||||
public ResponseProfile[] ResponseProfiles { get; set; } = Array.Empty<ResponseProfile>();
|
public ResponseProfile[] ResponseProfiles { get; set; } = Array.Empty<ResponseProfile>();
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets or sets the SubtitleProfiles.
|
/// Gets or sets the subtitle profiles.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public SubtitleProfile[] SubtitleProfiles { get; set; } = Array.Empty<SubtitleProfile>();
|
public SubtitleProfile[] SubtitleProfiles { get; set; } = Array.Empty<SubtitleProfile>();
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue