mirror of
https://github.com/jellyfin/jellyfin.git
synced 2025-07-09 03:04:24 -04:00
Move LiveTvService.cs to Jellyfin.Api
This commit is contained in:
parent
3bf19d1e93
commit
f35774170f
1151
Jellyfin.Api/Controllers/LiveTvController.cs
Normal file
1151
Jellyfin.Api/Controllers/LiveTvController.cs
Normal file
File diff suppressed because it is too large
Load Diff
@ -23,7 +23,7 @@ namespace Jellyfin.Api.Extensions
|
|||||||
/// <param name="dtoOptions">DtoOptions object.</param>
|
/// <param name="dtoOptions">DtoOptions object.</param>
|
||||||
/// <param name="fields">Comma delimited string of fields.</param>
|
/// <param name="fields">Comma delimited string of fields.</param>
|
||||||
/// <returns>Modified DtoOptions object.</returns>
|
/// <returns>Modified DtoOptions object.</returns>
|
||||||
internal static DtoOptions AddItemFields(this DtoOptions dtoOptions, string fields)
|
internal static DtoOptions AddItemFields(this DtoOptions dtoOptions, string? fields)
|
||||||
{
|
{
|
||||||
if (string.IsNullOrEmpty(fields))
|
if (string.IsNullOrEmpty(fields))
|
||||||
{
|
{
|
||||||
@ -122,11 +122,11 @@ namespace Jellyfin.Api.Extensions
|
|||||||
/// <param name="enableImageTypes">Enable image types.</param>
|
/// <param name="enableImageTypes">Enable image types.</param>
|
||||||
/// <returns>Modified DtoOptions object.</returns>
|
/// <returns>Modified DtoOptions object.</returns>
|
||||||
internal static DtoOptions AddAdditionalDtoOptions(
|
internal static DtoOptions AddAdditionalDtoOptions(
|
||||||
in DtoOptions dtoOptions,
|
this DtoOptions dtoOptions,
|
||||||
bool? enableImages,
|
bool? enableImages,
|
||||||
bool? enableUserData,
|
bool? enableUserData,
|
||||||
int? imageTypeLimit,
|
int? imageTypeLimit,
|
||||||
string enableImageTypes)
|
string? enableImageTypes)
|
||||||
{
|
{
|
||||||
dtoOptions.EnableImages = enableImages ?? true;
|
dtoOptions.EnableImages = enableImages ?? true;
|
||||||
|
|
||||||
|
@ -1,7 +1,10 @@
|
|||||||
using System;
|
using System;
|
||||||
|
using System.Linq;
|
||||||
using Jellyfin.Data.Enums;
|
using Jellyfin.Data.Enums;
|
||||||
using MediaBrowser.Controller.Net;
|
using MediaBrowser.Controller.Net;
|
||||||
using MediaBrowser.Controller.Session;
|
using MediaBrowser.Controller.Session;
|
||||||
|
using MediaBrowser.Model.Entities;
|
||||||
|
using MediaBrowser.Model.Querying;
|
||||||
using Microsoft.AspNetCore.Http;
|
using Microsoft.AspNetCore.Http;
|
||||||
|
|
||||||
namespace Jellyfin.Api.Helpers
|
namespace Jellyfin.Api.Helpers
|
||||||
@ -18,7 +21,7 @@ namespace Jellyfin.Api.Helpers
|
|||||||
/// <param name="separator">The char that separates the substrings.</param>
|
/// <param name="separator">The char that separates the substrings.</param>
|
||||||
/// <param name="removeEmpty">Option to remove empty substrings from the array.</param>
|
/// <param name="removeEmpty">Option to remove empty substrings from the array.</param>
|
||||||
/// <returns>An array of the substrings.</returns>
|
/// <returns>An array of the substrings.</returns>
|
||||||
internal static string[] Split(string value, char separator, bool removeEmpty)
|
internal static string[] Split(string? value, char separator, bool removeEmpty)
|
||||||
{
|
{
|
||||||
if (string.IsNullOrWhiteSpace(value))
|
if (string.IsNullOrWhiteSpace(value))
|
||||||
{
|
{
|
||||||
@ -73,5 +76,78 @@ namespace Jellyfin.Api.Helpers
|
|||||||
|
|
||||||
return session;
|
return session;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets the item fields.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="fields">The item field string.</param>
|
||||||
|
/// <returns>Array of parsed item fields.</returns>
|
||||||
|
internal static ItemFields[] GetItemFields(string fields)
|
||||||
|
{
|
||||||
|
if (string.IsNullOrEmpty(fields))
|
||||||
|
{
|
||||||
|
return Array.Empty<ItemFields>();
|
||||||
|
}
|
||||||
|
|
||||||
|
return Split(fields, ',', true)
|
||||||
|
.Select(v =>
|
||||||
|
{
|
||||||
|
if (Enum.TryParse(v, true, out ItemFields value))
|
||||||
|
{
|
||||||
|
return (ItemFields?)value;
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
})
|
||||||
|
.Where(i => i.HasValue)
|
||||||
|
.Select(i => i!.Value)
|
||||||
|
.ToArray();
|
||||||
|
}
|
||||||
|
|
||||||
|
internal static Guid[] GetGuids(string? value)
|
||||||
|
{
|
||||||
|
if (string.IsNullOrEmpty(value))
|
||||||
|
{
|
||||||
|
return Array.Empty<Guid>();
|
||||||
|
}
|
||||||
|
|
||||||
|
return Split(value, ',', true)
|
||||||
|
.Select(i => new Guid(i))
|
||||||
|
.ToArray();
|
||||||
|
}
|
||||||
|
|
||||||
|
internal static ValueTuple<string, SortOrder>[] GetOrderBy(string? sortBy, string? requestedSortOrder)
|
||||||
|
{
|
||||||
|
var val = sortBy;
|
||||||
|
|
||||||
|
if (string.IsNullOrEmpty(val))
|
||||||
|
{
|
||||||
|
return Array.Empty<ValueTuple<string, SortOrder>>();
|
||||||
|
}
|
||||||
|
|
||||||
|
var vals = val.Split(',');
|
||||||
|
if (string.IsNullOrWhiteSpace(requestedSortOrder))
|
||||||
|
{
|
||||||
|
requestedSortOrder = "Ascending";
|
||||||
|
}
|
||||||
|
|
||||||
|
var sortOrders = requestedSortOrder.Split(',');
|
||||||
|
|
||||||
|
var result = new ValueTuple<string, SortOrder>[vals.Length];
|
||||||
|
|
||||||
|
for (var i = 0; i < vals.Length; i++)
|
||||||
|
{
|
||||||
|
var sortOrderIndex = sortOrders.Length > i ? i : 0;
|
||||||
|
|
||||||
|
var sortOrderValue = sortOrders.Length > sortOrderIndex ? sortOrders[sortOrderIndex] : null;
|
||||||
|
var sortOrder = string.Equals(sortOrderValue, "Descending", StringComparison.OrdinalIgnoreCase)
|
||||||
|
? SortOrder.Descending
|
||||||
|
: SortOrder.Ascending;
|
||||||
|
|
||||||
|
result[i] = new ValueTuple<string, SortOrder>(vals[i], sortOrder);
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
32
Jellyfin.Api/Models/LiveTvDtos/ChannelMappingOptionsDto.cs
Normal file
32
Jellyfin.Api/Models/LiveTvDtos/ChannelMappingOptionsDto.cs
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using MediaBrowser.Controller.LiveTv;
|
||||||
|
using MediaBrowser.Model.Dto;
|
||||||
|
|
||||||
|
namespace Jellyfin.Api.Models.LiveTvDtos
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Channel mapping options dto.
|
||||||
|
/// </summary>
|
||||||
|
public class ChannelMappingOptionsDto
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets list of tuner channels.
|
||||||
|
/// </summary>
|
||||||
|
public List<TunerChannelMapping> TunerChannels { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets list of provider channels.
|
||||||
|
/// </summary>
|
||||||
|
public List<NameIdPair> ProviderChannels { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets list of mappings.
|
||||||
|
/// </summary>
|
||||||
|
public NameValuePair[] Mappings { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets provider name.
|
||||||
|
/// </summary>
|
||||||
|
public string? ProviderName { get; set; }
|
||||||
|
}
|
||||||
|
}
|
166
Jellyfin.Api/Models/LiveTvDtos/GetProgramsDto.cs
Normal file
166
Jellyfin.Api/Models/LiveTvDtos/GetProgramsDto.cs
Normal file
@ -0,0 +1,166 @@
|
|||||||
|
using System;
|
||||||
|
|
||||||
|
namespace Jellyfin.Api.Models.LiveTvDtos
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Get programs dto.
|
||||||
|
/// </summary>
|
||||||
|
public class GetProgramsDto
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets the channels to return guide information for.
|
||||||
|
/// </summary>
|
||||||
|
public string? ChannelIds { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets optional. Filter by user id.
|
||||||
|
/// </summary>
|
||||||
|
public Guid UserId { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets the minimum premiere start date.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public DateTime? MinStartDate { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets filter by programs that have completed airing, or not.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public bool? HasAired { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets filter by programs that are currently airing, or not.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public bool? IsAiring { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets the maximum premiere start date.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public DateTime? MaxStartDate { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets the minimum premiere end date.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public DateTime? MinEndDate { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets the maximum premiere end date.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public DateTime? MaxEndDate { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets filter for movies.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public bool? IsMovie { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets filter for series.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public bool? IsSeries { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets filter for news.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public bool? IsNews { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets filter for kids.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public bool? IsKids { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets filter for sports.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public bool? IsSports { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets the record index to start at. All items with a lower index will be dropped from the results.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public int? StartIndex { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets the maximum number of records to return.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public int? Limit { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public string? SortBy { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets sort Order - Ascending,Descending.
|
||||||
|
/// </summary>
|
||||||
|
public string? SortOrder { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets the genres to return guide information for.
|
||||||
|
/// </summary>
|
||||||
|
public string? Genres { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets the genre ids to return guide information for.
|
||||||
|
/// </summary>
|
||||||
|
public string? GenreIds { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets include image information in output.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public bool? EnableImages { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets a value indicating whether retrieve total record count.
|
||||||
|
/// </summary>
|
||||||
|
public bool EnableTotalRecordCount { get; set; } = true;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets the max number of images to return, per image type.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public int? ImageTypeLimit { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets the image types to include in the output.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public string? EnableImageTypes { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets include user data.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public bool? EnableUserData { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets filter by series timer id.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public string? SeriesTimerId { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets filter by library series id.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public Guid LibrarySeriesId { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets or sets specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
|
||||||
|
/// Optional.
|
||||||
|
/// </summary>
|
||||||
|
public string? Fields { get; set; }
|
||||||
|
}
|
||||||
|
}
|
@ -30,638 +30,6 @@ using Microsoft.Net.Http.Headers;
|
|||||||
|
|
||||||
namespace MediaBrowser.Api.LiveTv
|
namespace MediaBrowser.Api.LiveTv
|
||||||
{
|
{
|
||||||
/// <summary>
|
|
||||||
/// This is insecure right now to avoid windows phone refactoring
|
|
||||||
/// </summary>
|
|
||||||
[Route("/LiveTv/Info", "GET", Summary = "Gets available live tv services.")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetLiveTvInfo : IReturn<LiveTvInfo>
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Channels", "GET", Summary = "Gets available live tv channels.")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetChannels : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Type", Description = "Optional filter by channel type.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public ChannelType? Type { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public Guid UserId { get; set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Skips over a given number of items within the results. Use for paging.
|
|
||||||
/// </summary>
|
|
||||||
/// <value>The start index.</value>
|
|
||||||
[ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? StartIndex { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsMovie", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsMovie { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsSeries", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsSeries { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsNews", Description = "Optional filter for news.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsNews { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsKids", Description = "Optional filter for kids.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsKids { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsSports", Description = "Optional filter for sports.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsSports { get; set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// The maximum number of items to return
|
|
||||||
/// </summary>
|
|
||||||
/// <value>The limit.</value>
|
|
||||||
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? Limit { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsFavorite", Description = "Filter by channels that are favorites, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? IsFavorite { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsLiked", Description = "Filter by channels that are liked, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? IsLiked { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsDisliked", Description = "Filter by channels that are disliked, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? IsDisliked { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableFavoriteSorting", Description = "Incorporate favorite and like status into channel sorting.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool EnableFavoriteSorting { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? EnableImages { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? ImageTypeLimit { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string EnableImageTypes { get; set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Fields to return within the items, in addition to basic information
|
|
||||||
/// </summary>
|
|
||||||
/// <value>The fields.</value>
|
|
||||||
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
|
|
||||||
public string Fields { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "AddCurrentProgram", Description = "Optional. Adds current program info to each channel", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool AddCurrentProgram { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? EnableUserData { get; set; }
|
|
||||||
|
|
||||||
public string SortBy { get; set; }
|
|
||||||
|
|
||||||
public SortOrder? SortOrder { get; set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the order by.
|
|
||||||
/// </summary>
|
|
||||||
/// <returns>IEnumerable{ItemSortBy}.</returns>
|
|
||||||
public string[] GetOrderBy()
|
|
||||||
{
|
|
||||||
var val = SortBy;
|
|
||||||
|
|
||||||
if (string.IsNullOrEmpty(val))
|
|
||||||
{
|
|
||||||
return Array.Empty<string>();
|
|
||||||
}
|
|
||||||
|
|
||||||
return val.Split(',');
|
|
||||||
}
|
|
||||||
|
|
||||||
public GetChannels()
|
|
||||||
{
|
|
||||||
AddCurrentProgram = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Channels/{Id}", "GET", Summary = "Gets a live tv channel")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetChannel : IReturn<BaseItemDto>
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Gets or sets the id.
|
|
||||||
/// </summary>
|
|
||||||
/// <value>The id.</value>
|
|
||||||
[ApiMember(Name = "Id", Description = "Channel Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public Guid UserId { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Recordings", "GET", Summary = "Gets live tv recordings")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetRecordings : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "ChannelId", Description = "Optional filter by channel id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string ChannelId { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public Guid UserId { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? StartIndex { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? Limit { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Status", Description = "Optional filter by recording status.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public RecordingStatus? Status { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Status", Description = "Optional filter by recordings that are in progress, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? IsInProgress { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "SeriesTimerId", Description = "Optional filter by recordings belonging to a series timer", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string SeriesTimerId { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? EnableImages { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? ImageTypeLimit { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string EnableImageTypes { get; set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Fields to return within the items, in addition to basic information
|
|
||||||
/// </summary>
|
|
||||||
/// <value>The fields.</value>
|
|
||||||
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
|
|
||||||
public string Fields { get; set; }
|
|
||||||
|
|
||||||
public bool EnableTotalRecordCount { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? EnableUserData { get; set; }
|
|
||||||
|
|
||||||
public bool? IsMovie { get; set; }
|
|
||||||
public bool? IsSeries { get; set; }
|
|
||||||
public bool? IsKids { get; set; }
|
|
||||||
public bool? IsSports { get; set; }
|
|
||||||
public bool? IsNews { get; set; }
|
|
||||||
public bool? IsLibraryItem { get; set; }
|
|
||||||
|
|
||||||
public GetRecordings()
|
|
||||||
{
|
|
||||||
EnableTotalRecordCount = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Recordings/Series", "GET", Summary = "Gets live tv recordings")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetRecordingSeries : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "ChannelId", Description = "Optional filter by channel id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string ChannelId { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string UserId { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "GroupId", Description = "Optional filter by recording group.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string GroupId { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? StartIndex { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? Limit { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Status", Description = "Optional filter by recording status.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public RecordingStatus? Status { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Status", Description = "Optional filter by recordings that are in progress, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? IsInProgress { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "SeriesTimerId", Description = "Optional filter by recordings belonging to a series timer", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string SeriesTimerId { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? EnableImages { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? ImageTypeLimit { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string EnableImageTypes { get; set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Fields to return within the items, in addition to basic information
|
|
||||||
/// </summary>
|
|
||||||
/// <value>The fields.</value>
|
|
||||||
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
|
|
||||||
public string Fields { get; set; }
|
|
||||||
|
|
||||||
public bool EnableTotalRecordCount { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? EnableUserData { get; set; }
|
|
||||||
|
|
||||||
public GetRecordingSeries()
|
|
||||||
{
|
|
||||||
EnableTotalRecordCount = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Recordings/Groups", "GET", Summary = "Gets live tv recording groups")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetRecordingGroups : IReturn<QueryResult<BaseItemDto>>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string UserId { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Recordings/Folders", "GET", Summary = "Gets recording folders")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetRecordingFolders : IReturn<BaseItemDto[]>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public Guid UserId { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Recordings/{Id}", "GET", Summary = "Gets a live tv recording")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetRecording : IReturn<BaseItemDto>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Recording Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public Guid UserId { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Tuners/{Id}/Reset", "POST", Summary = "Resets a tv tuner")]
|
|
||||||
[Authenticated]
|
|
||||||
public class ResetTuner : IReturnVoid
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Tuner Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Timers/{Id}", "GET", Summary = "Gets a live tv timer")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetTimer : IReturn<TimerInfoDto>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Timers/Defaults", "GET", Summary = "Gets default values for a new timer")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetDefaultTimer : IReturn<SeriesTimerInfoDto>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "ProgramId", Description = "Optional, to attach default values based on a program.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string ProgramId { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Timers", "GET", Summary = "Gets live tv timers")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetTimers : IReturn<QueryResult<TimerInfoDto>>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "ChannelId", Description = "Optional filter by channel id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string ChannelId { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "SeriesTimerId", Description = "Optional filter by timers belonging to a series timer", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string SeriesTimerId { get; set; }
|
|
||||||
|
|
||||||
public bool? IsActive { get; set; }
|
|
||||||
|
|
||||||
public bool? IsScheduled { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Programs", "GET,POST", Summary = "Gets available live tv epgs..")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetPrograms : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "ChannelIds", Description = "The channels to return guide information for.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public string ChannelIds { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "UserId", Description = "Optional filter by user id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public Guid UserId { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "MinStartDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public string MinStartDate { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "HasAired", Description = "Optional. Filter by programs that have completed airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? HasAired { get; set; }
|
|
||||||
public bool? IsAiring { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "MaxStartDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public string MaxStartDate { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "MinEndDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public string MinEndDate { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "MaxEndDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public string MaxEndDate { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsMovie", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsMovie { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsSeries", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsSeries { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsNews", Description = "Optional filter for news.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsNews { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsKids", Description = "Optional filter for kids.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsKids { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsSports", Description = "Optional filter for sports.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsSports { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? StartIndex { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? Limit { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "SortBy", Description = "Optional. Specify one or more sort orders, comma delimeted. Options: Name, StartDate", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
|
|
||||||
public string SortBy { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "SortOrder", Description = "Sort Order - Ascending,Descending", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string SortOrder { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Genres", Description = "The genres to return guide information for.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public string Genres { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "GenreIds", Description = "The genres to return guide information for.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public string GenreIds { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? EnableImages { get; set; }
|
|
||||||
|
|
||||||
public bool EnableTotalRecordCount { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? ImageTypeLimit { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string EnableImageTypes { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? EnableUserData { get; set; }
|
|
||||||
|
|
||||||
public string SeriesTimerId { get; set; }
|
|
||||||
public Guid LibrarySeriesId { get; set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Fields to return within the items, in addition to basic information
|
|
||||||
/// </summary>
|
|
||||||
/// <value>The fields.</value>
|
|
||||||
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
|
|
||||||
public string Fields { get; set; }
|
|
||||||
|
|
||||||
public GetPrograms()
|
|
||||||
{
|
|
||||||
EnableTotalRecordCount = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Programs/Recommended", "GET", Summary = "Gets available live tv epgs..")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetRecommendedPrograms : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
|
|
||||||
{
|
|
||||||
public bool EnableTotalRecordCount { get; set; }
|
|
||||||
|
|
||||||
public GetRecommendedPrograms()
|
|
||||||
{
|
|
||||||
EnableTotalRecordCount = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
[ApiMember(Name = "UserId", Description = "Optional filter by user id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public Guid UserId { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? Limit { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsAiring", Description = "Optional. Filter by programs that are currently airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? IsAiring { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "HasAired", Description = "Optional. Filter by programs that have completed airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? HasAired { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsSeries", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsSeries { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsMovie", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsMovie { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsNews", Description = "Optional filter for news.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsNews { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsKids", Description = "Optional filter for kids.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsKids { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "IsSports", Description = "Optional filter for sports.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public bool? IsSports { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? EnableImages { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
||||||
public int? ImageTypeLimit { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string EnableImageTypes { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "GenreIds", Description = "The genres to return guide information for.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public string GenreIds { get; set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Fields to return within the items, in addition to basic information
|
|
||||||
/// </summary>
|
|
||||||
/// <value>The fields.</value>
|
|
||||||
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
|
|
||||||
public string Fields { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
|
|
||||||
public bool? EnableUserData { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Programs/{Id}", "GET", Summary = "Gets a live tv program")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetProgram : IReturn<BaseItemDto>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Program Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public Guid UserId { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
[Route("/LiveTv/Recordings/{Id}", "DELETE", Summary = "Deletes a live tv recording")]
|
|
||||||
[Authenticated]
|
|
||||||
public class DeleteRecording : IReturnVoid
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Recording Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
|
|
||||||
public Guid Id { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Timers/{Id}", "DELETE", Summary = "Cancels a live tv timer")]
|
|
||||||
[Authenticated]
|
|
||||||
public class CancelTimer : IReturnVoid
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Timers/{Id}", "POST", Summary = "Updates a live tv timer")]
|
|
||||||
[Authenticated]
|
|
||||||
public class UpdateTimer : TimerInfoDto, IReturnVoid
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Timers", "POST", Summary = "Creates a live tv timer")]
|
|
||||||
[Authenticated]
|
|
||||||
public class CreateTimer : TimerInfoDto, IReturnVoid
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/SeriesTimers/{Id}", "GET", Summary = "Gets a live tv series timer")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetSeriesTimer : IReturn<TimerInfoDto>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/SeriesTimers", "GET", Summary = "Gets live tv series timers")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetSeriesTimers : IReturn<QueryResult<SeriesTimerInfoDto>>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "SortBy", Description = "Optional. Sort by SortName or Priority", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public string SortBy { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "SortOrder", Description = "Optional. Sort in Ascending or Descending order", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
|
|
||||||
public SortOrder SortOrder { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/SeriesTimers/{Id}", "DELETE", Summary = "Cancels a live tv series timer")]
|
|
||||||
[Authenticated]
|
|
||||||
public class CancelSeriesTimer : IReturnVoid
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/SeriesTimers/{Id}", "POST", Summary = "Updates a live tv series timer")]
|
|
||||||
[Authenticated]
|
|
||||||
public class UpdateSeriesTimer : SeriesTimerInfoDto, IReturnVoid
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/SeriesTimers", "POST", Summary = "Creates a live tv series timer")]
|
|
||||||
[Authenticated]
|
|
||||||
public class CreateSeriesTimer : SeriesTimerInfoDto, IReturnVoid
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Recordings/Groups/{Id}", "GET", Summary = "Gets a recording group")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetRecordingGroup : IReturn<BaseItemDto>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Recording group Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/GuideInfo", "GET", Summary = "Gets guide info")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetGuideInfo : IReturn<GuideInfo>
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/TunerHosts", "POST", Summary = "Adds a tuner host")]
|
|
||||||
[Authenticated]
|
|
||||||
public class AddTunerHost : TunerHostInfo, IReturn<TunerHostInfo>
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/TunerHosts", "DELETE", Summary = "Deletes a tuner host")]
|
|
||||||
[Authenticated]
|
|
||||||
public class DeleteTunerHost : IReturnVoid
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Tuner host id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "DELETE")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/ListingProviders/Default", "GET")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetDefaultListingProvider : ListingsProviderInfo, IReturn<ListingsProviderInfo>
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/ListingProviders", "POST", Summary = "Adds a listing provider")]
|
|
||||||
[Authenticated]
|
|
||||||
public class AddListingProvider : ListingsProviderInfo, IReturn<ListingsProviderInfo>
|
|
||||||
{
|
|
||||||
public bool ValidateLogin { get; set; }
|
|
||||||
public bool ValidateListings { get; set; }
|
|
||||||
public string Pw { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/ListingProviders", "DELETE", Summary = "Deletes a listing provider")]
|
|
||||||
[Authenticated]
|
|
||||||
public class DeleteListingProvider : IReturnVoid
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Provider id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "DELETE")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/ListingProviders/Lineups", "GET", Summary = "Gets available lineups")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetLineups : IReturn<List<NameIdPair>>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Provider id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Type", Description = "Provider Type", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string Type { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Location", Description = "Location", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string Location { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Country", Description = "Country", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public string Country { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/ListingProviders/SchedulesDirect/Countries", "GET", Summary = "Gets available lineups")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetSchedulesDirectCountries
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/ChannelMappingOptions")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetChannelMappingOptions
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Provider id", IsRequired = true, DataType = "string", ParameterType = "query")]
|
|
||||||
public string ProviderId { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/ChannelMappings")]
|
|
||||||
[Authenticated]
|
|
||||||
public class SetChannelMapping
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Id", Description = "Provider id", IsRequired = true, DataType = "string", ParameterType = "query")]
|
|
||||||
public string ProviderId { get; set; }
|
|
||||||
public string TunerChannelId { get; set; }
|
|
||||||
public string ProviderChannelId { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
public class ChannelMappingOptions
|
|
||||||
{
|
|
||||||
public List<TunerChannelMapping> TunerChannels { get; set; }
|
|
||||||
public List<NameIdPair> ProviderChannels { get; set; }
|
|
||||||
public NameValuePair[] Mappings { get; set; }
|
|
||||||
public string ProviderName { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/LiveStreamFiles/{Id}/stream.{Container}", "GET", Summary = "Gets a live tv channel")]
|
[Route("/LiveTv/LiveStreamFiles/{Id}/stream.{Container}", "GET", Summary = "Gets a live tv channel")]
|
||||||
public class GetLiveStreamFile
|
public class GetLiveStreamFile
|
||||||
{
|
{
|
||||||
@ -675,20 +43,6 @@ namespace MediaBrowser.Api.LiveTv
|
|||||||
public string Id { get; set; }
|
public string Id { get; set; }
|
||||||
}
|
}
|
||||||
|
|
||||||
[Route("/LiveTv/TunerHosts/Types", "GET")]
|
|
||||||
[Authenticated]
|
|
||||||
public class GetTunerHostTypes : IReturn<List<NameIdPair>>
|
|
||||||
{
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/LiveTv/Tuners/Discvover", "GET")]
|
|
||||||
[Authenticated]
|
|
||||||
public class DiscoverTuners : IReturn<List<TunerHostInfo>>
|
|
||||||
{
|
|
||||||
public bool NewDevicesOnly { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
public class LiveTvService : BaseApiService
|
public class LiveTvService : BaseApiService
|
||||||
{
|
{
|
||||||
private readonly ILiveTvManager _liveTvManager;
|
private readonly ILiveTvManager _liveTvManager;
|
||||||
@ -733,22 +87,6 @@ namespace MediaBrowser.Api.LiveTv
|
|||||||
return ToOptimizedResult(list);
|
return ToOptimizedResult(list);
|
||||||
}
|
}
|
||||||
|
|
||||||
public object Get(GetRecordingFolders request)
|
|
||||||
{
|
|
||||||
var user = request.UserId.Equals(Guid.Empty) ? null : _userManager.GetUserById(request.UserId);
|
|
||||||
var folders = _liveTvManager.GetRecordingFolders(user);
|
|
||||||
|
|
||||||
var returnArray = _dtoService.GetBaseItemDtos(folders, new DtoOptions(), user);
|
|
||||||
|
|
||||||
var result = new QueryResult<BaseItemDto>
|
|
||||||
{
|
|
||||||
Items = returnArray,
|
|
||||||
TotalRecordCount = returnArray.Count
|
|
||||||
};
|
|
||||||
|
|
||||||
return ToOptimizedResult(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
public object Get(GetLiveRecordingFile request)
|
public object Get(GetLiveRecordingFile request)
|
||||||
{
|
{
|
||||||
var path = _liveTvManager.GetEmbyTvActiveRecordingPath(request.Id);
|
var path = _liveTvManager.GetEmbyTvActiveRecordingPath(request.Id);
|
||||||
@ -929,55 +267,6 @@ namespace MediaBrowser.Api.LiveTv
|
|||||||
return ToOptimizedResult(info);
|
return ToOptimizedResult(info);
|
||||||
}
|
}
|
||||||
|
|
||||||
public object Get(GetLiveTvInfo request)
|
|
||||||
{
|
|
||||||
var info = _liveTvManager.GetLiveTvInfo(CancellationToken.None);
|
|
||||||
|
|
||||||
return ToOptimizedResult(info);
|
|
||||||
}
|
|
||||||
|
|
||||||
public object Get(GetChannels request)
|
|
||||||
{
|
|
||||||
var options = GetDtoOptions(_authContext, request);
|
|
||||||
|
|
||||||
var channelResult = _liveTvManager.GetInternalChannels(new LiveTvChannelQuery
|
|
||||||
{
|
|
||||||
ChannelType = request.Type,
|
|
||||||
UserId = request.UserId,
|
|
||||||
StartIndex = request.StartIndex,
|
|
||||||
Limit = request.Limit,
|
|
||||||
IsFavorite = request.IsFavorite,
|
|
||||||
IsLiked = request.IsLiked,
|
|
||||||
IsDisliked = request.IsDisliked,
|
|
||||||
EnableFavoriteSorting = request.EnableFavoriteSorting,
|
|
||||||
IsMovie = request.IsMovie,
|
|
||||||
IsSeries = request.IsSeries,
|
|
||||||
IsNews = request.IsNews,
|
|
||||||
IsKids = request.IsKids,
|
|
||||||
IsSports = request.IsSports,
|
|
||||||
SortBy = request.GetOrderBy(),
|
|
||||||
SortOrder = request.SortOrder ?? SortOrder.Ascending,
|
|
||||||
AddCurrentProgram = request.AddCurrentProgram
|
|
||||||
|
|
||||||
}, options, CancellationToken.None);
|
|
||||||
|
|
||||||
var user = request.UserId.Equals(Guid.Empty) ? null : _userManager.GetUserById(request.UserId);
|
|
||||||
|
|
||||||
RemoveFields(options);
|
|
||||||
|
|
||||||
options.AddCurrentProgram = request.AddCurrentProgram;
|
|
||||||
|
|
||||||
var returnArray = _dtoService.GetBaseItemDtos(channelResult.Items, options, user);
|
|
||||||
|
|
||||||
var result = new QueryResult<BaseItemDto>
|
|
||||||
{
|
|
||||||
Items = returnArray,
|
|
||||||
TotalRecordCount = channelResult.TotalRecordCount
|
|
||||||
};
|
|
||||||
|
|
||||||
return ToOptimizedResult(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
private void RemoveFields(DtoOptions options)
|
private void RemoveFields(DtoOptions options)
|
||||||
{
|
{
|
||||||
var fields = options.Fields.ToList();
|
var fields = options.Fields.ToList();
|
||||||
@ -989,19 +278,6 @@ namespace MediaBrowser.Api.LiveTv
|
|||||||
options.Fields = fields.ToArray();
|
options.Fields = fields.ToArray();
|
||||||
}
|
}
|
||||||
|
|
||||||
public object Get(GetChannel request)
|
|
||||||
{
|
|
||||||
var user = _userManager.GetUserById(request.UserId);
|
|
||||||
|
|
||||||
var item = string.IsNullOrEmpty(request.Id) ? _libraryManager.GetUserRootFolder() : _libraryManager.GetItemById(request.Id);
|
|
||||||
|
|
||||||
var dtoOptions = GetDtoOptions(_authContext, request);
|
|
||||||
|
|
||||||
var result = _dtoService.GetBaseItemDto(item, dtoOptions, user);
|
|
||||||
|
|
||||||
return ToOptimizedResult(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
public async Task<object> Get(GetPrograms request)
|
public async Task<object> Get(GetPrograms request)
|
||||||
{
|
{
|
||||||
var user = request.UserId.Equals(Guid.Empty) ? null : _userManager.GetUserById(request.UserId);
|
var user = request.UserId.Equals(Guid.Empty) ? null : _userManager.GetUserById(request.UserId);
|
||||||
@ -1090,74 +366,6 @@ namespace MediaBrowser.Api.LiveTv
|
|||||||
return Get(request);
|
return Get(request);
|
||||||
}
|
}
|
||||||
|
|
||||||
public object Get(GetRecordings request)
|
|
||||||
{
|
|
||||||
var options = GetDtoOptions(_authContext, request);
|
|
||||||
|
|
||||||
var result = _liveTvManager.GetRecordings(new RecordingQuery
|
|
||||||
{
|
|
||||||
ChannelId = request.ChannelId,
|
|
||||||
UserId = request.UserId,
|
|
||||||
StartIndex = request.StartIndex,
|
|
||||||
Limit = request.Limit,
|
|
||||||
Status = request.Status,
|
|
||||||
SeriesTimerId = request.SeriesTimerId,
|
|
||||||
IsInProgress = request.IsInProgress,
|
|
||||||
EnableTotalRecordCount = request.EnableTotalRecordCount,
|
|
||||||
IsMovie = request.IsMovie,
|
|
||||||
IsNews = request.IsNews,
|
|
||||||
IsSeries = request.IsSeries,
|
|
||||||
IsKids = request.IsKids,
|
|
||||||
IsSports = request.IsSports,
|
|
||||||
IsLibraryItem = request.IsLibraryItem,
|
|
||||||
Fields = request.GetItemFields(),
|
|
||||||
ImageTypeLimit = request.ImageTypeLimit,
|
|
||||||
EnableImages = request.EnableImages
|
|
||||||
|
|
||||||
}, options);
|
|
||||||
|
|
||||||
return ToOptimizedResult(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
public object Get(GetRecordingSeries request)
|
|
||||||
{
|
|
||||||
return ToOptimizedResult(new QueryResult<BaseItemDto>());
|
|
||||||
}
|
|
||||||
|
|
||||||
public object Get(GetRecording request)
|
|
||||||
{
|
|
||||||
var user = _userManager.GetUserById(request.UserId);
|
|
||||||
|
|
||||||
var item = string.IsNullOrEmpty(request.Id) ? _libraryManager.GetUserRootFolder() : _libraryManager.GetItemById(request.Id);
|
|
||||||
|
|
||||||
var dtoOptions = GetDtoOptions(_authContext, request);
|
|
||||||
|
|
||||||
var result = _dtoService.GetBaseItemDto(item, dtoOptions, user);
|
|
||||||
|
|
||||||
return ToOptimizedResult(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
public async Task<object> Get(GetTimer request)
|
|
||||||
{
|
|
||||||
var result = await _liveTvManager.GetTimer(request.Id, CancellationToken.None).ConfigureAwait(false);
|
|
||||||
|
|
||||||
return ToOptimizedResult(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
public async Task<object> Get(GetTimers request)
|
|
||||||
{
|
|
||||||
var result = await _liveTvManager.GetTimers(new TimerQuery
|
|
||||||
{
|
|
||||||
ChannelId = request.ChannelId,
|
|
||||||
SeriesTimerId = request.SeriesTimerId,
|
|
||||||
IsActive = request.IsActive,
|
|
||||||
IsScheduled = request.IsScheduled
|
|
||||||
|
|
||||||
}, CancellationToken.None).ConfigureAwait(false);
|
|
||||||
|
|
||||||
return ToOptimizedResult(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
public void Delete(DeleteRecording request)
|
public void Delete(DeleteRecording request)
|
||||||
{
|
{
|
||||||
AssertUserCanManageLiveTv();
|
AssertUserCanManageLiveTv();
|
||||||
|
Loading…
x
Reference in New Issue
Block a user