jellyfin-server/MediaBrowser.Api/Playback/StreamRequest.cs

63 lines
2.7 KiB
C#
Raw Normal View History

using MediaBrowser.Controller.MediaEncoding;
using MediaBrowser.Model.Dlna;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.Services;
2013-02-26 21:53:51 +00:00
namespace MediaBrowser.Api.Playback
{
2013-02-27 04:19:05 +00:00
/// <summary>
/// Class StreamRequest
/// </summary>
public class StreamRequest : BaseEncodingJobOptions
2013-02-26 21:53:51 +00:00
{
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
2013-03-09 02:34:54 +00:00
[ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
2013-02-26 21:53:51 +00:00
public string Id { get; set; }
2014-03-22 16:16:43 +00:00
[ApiMember(Name = "MediaSourceId", Description = "The media version id, if playing an alternate version", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string MediaSourceId { get; set; }
2013-10-03 14:14:40 +00:00
[ApiMember(Name = "DeviceId", Description = "The device id of the client requesting. Used to stop encoding processes when needed.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string DeviceId { get; set; }
2014-01-18 05:55:21 +00:00
2017-02-17 21:11:13 +00:00
[ApiMember(Name = "Container", Description = "Container", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Container { get; set; }
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the audio codec.
/// </summary>
/// <value>The audio codec.</value>
2013-03-09 05:15:51 +00:00
[ApiMember(Name = "AudioCodec", Description = "Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
2014-03-23 20:07:02 +00:00
public string AudioCodec { get; set; }
2013-02-26 21:53:51 +00:00
2017-01-29 20:00:29 +00:00
public string SubtitleCodec { get; set; }
2014-03-26 15:06:48 +00:00
[ApiMember(Name = "DeviceProfileId", Description = "Optional. The dlna device profile id to utilize.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string DeviceProfileId { get; set; }
2014-02-13 05:11:54 +00:00
public string Params { get; set; }
2015-03-29 18:31:28 +00:00
public string PlaySessionId { get; set; }
2015-03-29 04:56:39 +00:00
public string LiveStreamId { get; set; }
public string Tag { get; set; }
2013-03-09 02:34:54 +00:00
}
public class VideoStreamRequest : StreamRequest
{
/// <summary>
/// Gets a value indicating whether this instance has fixed resolution.
/// </summary>
/// <value><c>true</c> if this instance has fixed resolution; otherwise, <c>false</c>.</value>
public bool HasFixedResolution
{
get
{
return Width.HasValue || Height.HasValue;
}
}
2016-07-13 19:09:31 +00:00
public bool EnableSubtitlesInManifest { get; set; }
2013-02-26 21:53:51 +00:00
}
}