jellyfin/MediaBrowser.Api/Playback/StreamRequest.cs

201 lines
11 KiB
C#
Raw Normal View History

2014-08-06 02:26:12 +00:00
using MediaBrowser.Model.Dlna;
using ServiceStack;
2013-02-26 21:53:51 +00:00
namespace MediaBrowser.Api.Playback
{
2013-02-27 04:19:05 +00:00
/// <summary>
/// Class StreamRequest
/// </summary>
2013-02-26 21:53:51 +00:00
public class StreamRequest
{
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
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
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the start time ticks.
/// </summary>
/// <value>The start time ticks.</value>
2013-03-09 02:34:54 +00:00
[ApiMember(Name = "StartTimeTicks", Description = "Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-26 21:53:51 +00:00
public long? StartTimeTicks { get; set; }
2014-06-28 19:35:30 +00:00
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the audio bit rate.
/// </summary>
/// <value>The audio bit rate.</value>
2013-03-09 05:15:51 +00:00
[ApiMember(Name = "AudioBitRate", Description = "Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-26 21:53:51 +00:00
public int? AudioBitRate { get; set; }
2013-03-09 02:34:54 +00:00
/// <summary>
/// Gets or sets the audio channels.
/// </summary>
/// <value>The audio channels.</value>
[ApiMember(Name = "AudioChannels", Description = "Optional. Specify a specific number of audio channels to encode to, e.g. 2", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? AudioChannels { get; set; }
2014-03-23 05:10:33 +00:00
[ApiMember(Name = "MaxAudioChannels", Description = "Optional. Specify a maximum number of audio channels to encode to, e.g. 2", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? MaxAudioChannels { get; set; }
2013-03-09 02:34:54 +00:00
/// <summary>
/// Gets or sets the audio sample rate.
/// </summary>
/// <value>The audio sample rate.</value>
[ApiMember(Name = "AudioSampleRate", Description = "Optional. Specify a specific audio sample rate, e.g. 44100", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? AudioSampleRate { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this <see cref="StreamRequest" /> is static.
/// </summary>
/// <value><c>true</c> if static; otherwise, <c>false</c>.</value>
[ApiMember(Name = "Static", Description = "Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool Static { get; set; }
2013-03-26 05:06:36 +00:00
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; }
2014-09-18 04:50:21 +00:00
public string ClientTime { get; set; }
2015-03-19 16:16:33 +00:00
public string StreamId { get; set; }
2014-08-29 04:06:30 +00:00
2014-09-03 02:30:24 +00:00
public string TranscodingJobId { get; set; }
2013-03-09 02:34:54 +00:00
}
public class VideoStreamRequest : StreamRequest
{
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the video codec.
/// </summary>
/// <value>The video codec.</value>
[ApiMember(Name = "VideoCodec", Description = "Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h264, mpeg4, theora, vpx, wmv.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
2014-03-23 20:07:02 +00:00
public string VideoCodec { get; set; }
2013-02-26 21:53:51 +00:00
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the video bit rate.
/// </summary>
/// <value>The video bit rate.</value>
2013-03-09 05:15:51 +00:00
[ApiMember(Name = "VideoBitRate", Description = "Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-26 21:53:51 +00:00
public int? VideoBitRate { get; set; }
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the index of the audio stream.
/// </summary>
/// <value>The index of the audio stream.</value>
2013-03-09 05:15:51 +00:00
[ApiMember(Name = "AudioStreamIndex", Description = "Optional. The index of the audio stream to use. If omitted the first audio stream will be used.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-26 21:53:51 +00:00
public int? AudioStreamIndex { get; set; }
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the index of the video stream.
/// </summary>
/// <value>The index of the video stream.</value>
2013-03-09 05:15:51 +00:00
[ApiMember(Name = "VideoStreamIndex", Description = "Optional. The index of the video stream to use. If omitted the first video stream will be used.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-26 21:53:51 +00:00
public int? VideoStreamIndex { get; set; }
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the index of the subtitle stream.
/// </summary>
/// <value>The index of the subtitle stream.</value>
2013-03-09 05:15:51 +00:00
[ApiMember(Name = "SubtitleStreamIndex", Description = "Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-26 21:53:51 +00:00
public int? SubtitleStreamIndex { get; set; }
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the width.
/// </summary>
/// <value>The width.</value>
2013-03-09 05:15:51 +00:00
[ApiMember(Name = "Width", Description = "Optional. The fixed horizontal resolution of the encoded video.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-26 21:53:51 +00:00
public int? Width { get; set; }
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the height.
/// </summary>
/// <value>The height.</value>
2013-03-09 05:15:51 +00:00
[ApiMember(Name = "Height", Description = "Optional. The fixed vertical resolution of the encoded video.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-26 21:53:51 +00:00
public int? Height { get; set; }
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the width of the max.
/// </summary>
/// <value>The width of the max.</value>
2013-03-09 05:15:51 +00:00
[ApiMember(Name = "MaxWidth", Description = "Optional. The maximum horizontal resolution of the encoded video.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-26 21:53:51 +00:00
public int? MaxWidth { get; set; }
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the height of the max.
/// </summary>
/// <value>The height of the max.</value>
2013-03-09 05:15:51 +00:00
[ApiMember(Name = "MaxHeight", Description = "Optional. The maximum vertical resolution of the encoded video.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-26 21:53:51 +00:00
public int? MaxHeight { get; set; }
2014-09-23 04:05:29 +00:00
[ApiMember(Name = "MaxRefFrames", Description = "Optional.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? MaxRefFrames { get; set; }
[ApiMember(Name = "MaxVideoBitDepth", Description = "Optional.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? MaxVideoBitDepth { get; set; }
2013-02-27 04:19:05 +00:00
/// <summary>
/// Gets or sets the framerate.
/// </summary>
/// <value>The framerate.</value>
2013-03-09 05:15:51 +00:00
[ApiMember(Name = "Framerate", Description = "Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.", IsRequired = false, DataType = "double", ParameterType = "query", Verb = "GET")]
2014-06-23 16:05:19 +00:00
public float? Framerate { get; set; }
2013-03-28 14:42:03 +00:00
2014-03-24 17:54:45 +00:00
[ApiMember(Name = "MaxFramerate", Description = "Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.", IsRequired = false, DataType = "double", ParameterType = "query", Verb = "GET")]
2014-06-23 16:05:19 +00:00
public float? MaxFramerate { get; set; }
2014-03-24 17:54:45 +00:00
2013-03-28 14:42:03 +00:00
/// <summary>
/// Gets or sets the profile.
/// </summary>
/// <value>The profile.</value>
[ApiMember(Name = "Profile", Description = "Optional. Specify a specific h264 profile, e.g. main, baseline, high.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string Profile { get; set; }
/// <summary>
/// Gets or sets the level.
/// </summary>
/// <value>The level.</value>
[ApiMember(Name = "Level", Description = "Optional. Specify a level for the h264 profile, e.g. 3, 3.1.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string Level { get; set; }
2014-08-06 02:26:12 +00:00
[ApiMember(Name = "SubtitleDeliveryMethod", Description = "Optional. Specify the subtitle delivery method.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public SubtitleDeliveryMethod SubtitleMethod { get; set; }
/// <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;
}
}
[ApiMember(Name = "EnableAutoStreamCopy", Description = "Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool EnableAutoStreamCopy { get; set; }
2014-11-12 04:51:40 +00:00
[ApiMember(Name = "Cabac", Description = "Enable if cabac encoding is required", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? Cabac { get; set; }
public VideoStreamRequest()
{
EnableAutoStreamCopy = true;
}
2013-02-26 21:53:51 +00:00
}
}