8825 lines
637 KiB
XML
8825 lines
637 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Jellyfin.Api</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Jellyfin.Api.Attributes.AcceptsFileAttribute">
|
|
<summary>
|
|
Internal produces image attribute.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Attributes.AcceptsFileAttribute.#ctor(System.String[])">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Attributes.AcceptsFileAttribute"/> class.
|
|
</summary>
|
|
<param name="contentTypes">Content types this endpoint produces.</param>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Attributes.AcceptsFileAttribute.ContentTypes">
|
|
<summary>
|
|
Gets the configured content types.
|
|
</summary>
|
|
<returns>the configured content types.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Attributes.AcceptsImageFileAttribute">
|
|
<summary>
|
|
Produces file attribute of "image/*".
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Attributes.AcceptsImageFileAttribute.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Attributes.AcceptsImageFileAttribute"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Attributes.ParameterObsoleteAttribute">
|
|
<summary>
|
|
Attribute to mark a parameter as obsolete.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Attributes.ProducesAudioFileAttribute">
|
|
<summary>
|
|
Produces file attribute of "image/*".
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Attributes.ProducesAudioFileAttribute.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Attributes.ProducesAudioFileAttribute"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Attributes.ProducesFileAttribute">
|
|
<summary>
|
|
Internal produces image attribute.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Attributes.ProducesFileAttribute.#ctor(System.String[])">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Attributes.ProducesFileAttribute"/> class.
|
|
</summary>
|
|
<param name="contentTypes">Content types this endpoint produces.</param>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Attributes.ProducesFileAttribute.ContentTypes">
|
|
<summary>
|
|
Gets the configured content types.
|
|
</summary>
|
|
<returns>the configured content types.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Attributes.ProducesImageFileAttribute">
|
|
<summary>
|
|
Produces file attribute of "image/*".
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Attributes.ProducesImageFileAttribute.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Attributes.ProducesImageFileAttribute"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Attributes.ProducesPlaylistFileAttribute">
|
|
<summary>
|
|
Produces file attribute of "image/*".
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Attributes.ProducesPlaylistFileAttribute.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Attributes.ProducesPlaylistFileAttribute"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Attributes.ProducesVideoFileAttribute">
|
|
<summary>
|
|
Produces file attribute of "video/*".
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Attributes.ProducesVideoFileAttribute.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Attributes.ProducesVideoFileAttribute"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.AnonymousLanAccessPolicy.AnonymousLanAccessHandler">
|
|
<summary>
|
|
LAN access handler. Allows anonymous users.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.AnonymousLanAccessPolicy.AnonymousLanAccessHandler.#ctor(MediaBrowser.Common.Net.INetworkManager,Microsoft.AspNetCore.Http.IHttpContextAccessor)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Auth.AnonymousLanAccessPolicy.AnonymousLanAccessHandler"/> class.
|
|
</summary>
|
|
<param name="networkManager">Instance of the <see cref="T:MediaBrowser.Common.Net.INetworkManager"/> interface.</param>
|
|
<param name="httpContextAccessor">Instance of the <see cref="T:Microsoft.AspNetCore.Http.IHttpContextAccessor"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.AnonymousLanAccessPolicy.AnonymousLanAccessHandler.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Jellyfin.Api.Auth.AnonymousLanAccessPolicy.AnonymousLanAccessRequirement)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.AnonymousLanAccessPolicy.AnonymousLanAccessRequirement">
|
|
<summary>
|
|
The local network authorization requirement. Allows anonymous users.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.CustomAuthenticationHandler">
|
|
<summary>
|
|
Custom authentication handler wrapping the legacy authentication.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.CustomAuthenticationHandler.#ctor(MediaBrowser.Controller.Net.IAuthService,Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions},Microsoft.Extensions.Logging.ILoggerFactory,System.Text.Encodings.Web.UrlEncoder)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Auth.CustomAuthenticationHandler" /> class.
|
|
</summary>
|
|
<param name="authService">The jellyfin authentication service.</param>
|
|
<param name="options">Options monitor.</param>
|
|
<param name="logger">The logger.</param>
|
|
<param name="encoder">The url encoder.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.CustomAuthenticationHandler.HandleAuthenticateAsync">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.DefaultAuthorizationPolicy.DefaultAuthorizationHandler">
|
|
<summary>
|
|
Default authorization handler.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.DefaultAuthorizationPolicy.DefaultAuthorizationHandler.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Common.Net.INetworkManager,Microsoft.AspNetCore.Http.IHttpContextAccessor)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Auth.DefaultAuthorizationPolicy.DefaultAuthorizationHandler"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="networkManager">Instance of the <see cref="T:MediaBrowser.Common.Net.INetworkManager"/> interface.</param>
|
|
<param name="httpContextAccessor">Instance of the <see cref="T:Microsoft.AspNetCore.Http.IHttpContextAccessor"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.DefaultAuthorizationPolicy.DefaultAuthorizationHandler.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Jellyfin.Api.Auth.DefaultAuthorizationPolicy.DefaultAuthorizationRequirement)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.DefaultAuthorizationPolicy.DefaultAuthorizationRequirement">
|
|
<summary>
|
|
The default authorization requirement.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.DefaultAuthorizationPolicy.DefaultAuthorizationRequirement.#ctor(System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Auth.DefaultAuthorizationPolicy.DefaultAuthorizationRequirement"/> class.
|
|
</summary>
|
|
<param name="validateParentalSchedule">A value indicating whether to validate parental schedule.</param>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Auth.DefaultAuthorizationPolicy.DefaultAuthorizationRequirement.ValidateParentalSchedule">
|
|
<summary>
|
|
Gets a value indicating whether to ignore parental schedule.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.FirstTimeSetupPolicy.FirstTimeSetupHandler">
|
|
<summary>
|
|
Authorization handler for requiring first time setup or default privileges.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.FirstTimeSetupPolicy.FirstTimeSetupHandler.#ctor(MediaBrowser.Common.Configuration.IConfigurationManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Auth.FirstTimeSetupPolicy.FirstTimeSetupHandler" /> class.
|
|
</summary>
|
|
<param name="configurationManager">Instance of the <see cref="T:MediaBrowser.Common.Configuration.IConfigurationManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.FirstTimeSetupPolicy.FirstTimeSetupHandler.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Jellyfin.Api.Auth.FirstTimeSetupPolicy.FirstTimeSetupRequirement)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.FirstTimeSetupPolicy.FirstTimeSetupRequirement">
|
|
<summary>
|
|
The authorization requirement, requiring incomplete first time setup or default privileges, for the authorization handler.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.FirstTimeSetupPolicy.FirstTimeSetupRequirement.#ctor(System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Auth.FirstTimeSetupPolicy.FirstTimeSetupRequirement"/> class.
|
|
</summary>
|
|
<param name="validateParentalSchedule">A value indicating whether to ignore parental schedule.</param>
|
|
<param name="requireAdmin">A value indicating whether administrator role is required.</param>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Auth.FirstTimeSetupPolicy.FirstTimeSetupRequirement.RequireAdmin">
|
|
<summary>
|
|
Gets a value indicating whether administrator role is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.LocalAccessOrRequiresElevationPolicy.LocalAccessOrRequiresElevationHandler">
|
|
<summary>
|
|
Local access or require elevated privileges handler.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.LocalAccessOrRequiresElevationPolicy.LocalAccessOrRequiresElevationHandler.#ctor(MediaBrowser.Common.Net.INetworkManager,Microsoft.AspNetCore.Http.IHttpContextAccessor)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Auth.LocalAccessOrRequiresElevationPolicy.LocalAccessOrRequiresElevationHandler"/> class.
|
|
</summary>
|
|
<param name="networkManager">Instance of the <see cref="T:MediaBrowser.Common.Net.INetworkManager"/> interface.</param>
|
|
<param name="httpContextAccessor">Instance of the <see cref="T:Microsoft.AspNetCore.Http.IHttpContextAccessor"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.LocalAccessOrRequiresElevationPolicy.LocalAccessOrRequiresElevationHandler.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Jellyfin.Api.Auth.LocalAccessOrRequiresElevationPolicy.LocalAccessOrRequiresElevationRequirement)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.LocalAccessOrRequiresElevationPolicy.LocalAccessOrRequiresElevationRequirement">
|
|
<summary>
|
|
The local access or elevated privileges authorization requirement.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.SyncPlayAccessPolicy.SyncPlayAccessHandler">
|
|
<summary>
|
|
Default authorization handler.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.SyncPlayAccessPolicy.SyncPlayAccessHandler.#ctor(MediaBrowser.Controller.SyncPlay.ISyncPlayManager,MediaBrowser.Controller.Library.IUserManager,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Auth.SyncPlayAccessPolicy.SyncPlayAccessHandler})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Auth.SyncPlayAccessPolicy.SyncPlayAccessHandler"/> class.
|
|
</summary>
|
|
<param name="syncPlayManager">Instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.ISyncPlayManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.SyncPlayAccessPolicy.SyncPlayAccessHandler.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Jellyfin.Api.Auth.SyncPlayAccessPolicy.SyncPlayAccessRequirement)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.SyncPlayAccessPolicy.SyncPlayAccessRequirement">
|
|
<summary>
|
|
The default authorization requirement.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.SyncPlayAccessPolicy.SyncPlayAccessRequirement.#ctor(Jellyfin.Data.Enums.SyncPlayAccessRequirementType)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Auth.SyncPlayAccessPolicy.SyncPlayAccessRequirement"/> class.
|
|
</summary>
|
|
<param name="requiredAccess">A value of <see cref="T:Jellyfin.Data.Enums.SyncPlayAccessRequirementType"/>.</param>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Auth.SyncPlayAccessPolicy.SyncPlayAccessRequirement.RequiredAccess">
|
|
<summary>
|
|
Gets the required SyncPlay access.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.UserPermissionPolicy.UserPermissionHandler">
|
|
<summary>
|
|
User permission authorization handler.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.UserPermissionPolicy.UserPermissionHandler.#ctor(MediaBrowser.Controller.Library.IUserManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Auth.UserPermissionPolicy.UserPermissionHandler"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.UserPermissionPolicy.UserPermissionHandler.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Jellyfin.Api.Auth.UserPermissionPolicy.UserPermissionRequirement)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Auth.UserPermissionPolicy.UserPermissionRequirement">
|
|
<summary>
|
|
The user permission requirement.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Auth.UserPermissionPolicy.UserPermissionRequirement.#ctor(Jellyfin.Database.Implementations.Enums.PermissionKind,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Auth.UserPermissionPolicy.UserPermissionRequirement"/> class.
|
|
</summary>
|
|
<param name="requiredPermission">The required <see cref="T:Jellyfin.Database.Implementations.Enums.PermissionKind"/>.</param>
|
|
<param name="validateParentalSchedule">Whether to validate the user's parental schedule.</param>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Auth.UserPermissionPolicy.UserPermissionRequirement.RequiredPermission">
|
|
<summary>
|
|
Gets the required user permission.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.BaseJellyfinApiController">
|
|
<summary>
|
|
Base api controller for the API setting a default route.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.BaseJellyfinApiController.Ok``1(System.Collections.Generic.IEnumerable{``0})">
|
|
<summary>
|
|
Create a new <see cref="T:Jellyfin.Api.Results.OkResult`1"/>.
|
|
</summary>
|
|
<param name="value">The value to return.</param>
|
|
<typeparam name="T">The type to return.</typeparam>
|
|
<returns>The <see cref="T:Microsoft.AspNetCore.Mvc.ActionResult`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.BaseJellyfinApiController.Ok``1(``0)">
|
|
<summary>
|
|
Create a new <see cref="T:Jellyfin.Api.Results.OkResult`1"/>.
|
|
</summary>
|
|
<param name="value">The value to return.</param>
|
|
<typeparam name="T">The type to return.</typeparam>
|
|
<returns>The <see cref="T:Microsoft.AspNetCore.Mvc.ActionResult`1"/>.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Constants.AuthenticationSchemes">
|
|
<summary>
|
|
Authentication schemes for user authentication in the API.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Constants.AuthenticationSchemes.CustomAuthentication">
|
|
<summary>
|
|
Scheme name for the custom legacy authentication.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Constants.InternalClaimTypes">
|
|
<summary>
|
|
Internal claim types for authorization.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Constants.InternalClaimTypes.UserId">
|
|
<summary>
|
|
User Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Constants.InternalClaimTypes.DeviceId">
|
|
<summary>
|
|
Device Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Constants.InternalClaimTypes.Device">
|
|
<summary>
|
|
Device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Constants.InternalClaimTypes.Client">
|
|
<summary>
|
|
Client.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Constants.InternalClaimTypes.Version">
|
|
<summary>
|
|
Version.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Constants.InternalClaimTypes.Token">
|
|
<summary>
|
|
Token.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Constants.InternalClaimTypes.IsApiKey">
|
|
<summary>
|
|
Is Api Key.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Constants.UserRoles">
|
|
<summary>
|
|
Constants for user roles used in the authentication and authorization for the API.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Constants.UserRoles.Guest">
|
|
<summary>
|
|
Guest user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Constants.UserRoles.User">
|
|
<summary>
|
|
Regular user with no special privileges.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Constants.UserRoles.Administrator">
|
|
<summary>
|
|
Administrator user with elevated privileges.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ActivityLogController">
|
|
<summary>
|
|
Activity log controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ActivityLogController.#ctor(MediaBrowser.Model.Activity.IActivityManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ActivityLogController"/> class.
|
|
</summary>
|
|
<param name="activityManager">Instance of <see cref="T:MediaBrowser.Model.Activity.IActivityManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ActivityLogController.GetLogEntries(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.Nullable{System.Guid},System.String,System.Nullable{Microsoft.Extensions.Logging.LogLevel},Jellyfin.Data.Enums.ActivityLogSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[])">
|
|
<summary>
|
|
Gets activity log entries.
|
|
</summary>
|
|
<param name="startIndex">The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">The maximum number of records to return.</param>
|
|
<param name="minDate">The minimum date.</param>
|
|
<param name="maxDate">The maximum date.</param>
|
|
<param name="hasUserId">Filter log entries if it has user id, or not.</param>
|
|
<param name="name">Filter by name.</param>
|
|
<param name="overview">Filter by overview.</param>
|
|
<param name="shortOverview">Filter by short overview.</param>
|
|
<param name="type">Filter by type.</param>
|
|
<param name="itemId">Filter by item id.</param>
|
|
<param name="username">Filter by username.</param>
|
|
<param name="severity">Filter by log severity.</param>
|
|
<param name="sortBy">Specify one or more sort orders. Format: SortBy=Name,Type.</param>
|
|
<param name="sortOrder">Sort Order..</param>
|
|
<response code="200">Activity log returned.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> containing the log entries.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ApiKeyController">
|
|
<summary>
|
|
Authentication controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ApiKeyController.#ctor(MediaBrowser.Controller.Security.IAuthenticationManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ApiKeyController"/> class.
|
|
</summary>
|
|
<param name="authenticationManager">Instance of <see cref="T:MediaBrowser.Controller.Security.IAuthenticationManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ApiKeyController.GetKeys">
|
|
<summary>
|
|
Get all keys.
|
|
</summary>
|
|
<response code="200">Api keys retrieved.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with all keys.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ApiKeyController.CreateKey(System.String)">
|
|
<summary>
|
|
Create a new api key.
|
|
</summary>
|
|
<param name="app">Name of the app using the authentication key.</param>
|
|
<response code="204">Api key created.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ApiKeyController.RevokeKey(System.String)">
|
|
<summary>
|
|
Remove an api key.
|
|
</summary>
|
|
<param name="key">The access token to delete.</param>
|
|
<response code="204">Api key deleted.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ArtistsController">
|
|
<summary>
|
|
The artists controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ArtistsController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Dto.IDtoService)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ArtistsController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ArtistsController.GetArtists(System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],MediaBrowser.Model.Querying.ItemFilter[],System.Nullable{System.Boolean},Jellyfin.Data.Enums.MediaType[],System.String[],System.Guid[],System.String[],System.String[],System.Int32[],System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.String,System.Guid[],System.String[],System.String[],System.Guid[],System.Nullable{System.Guid},System.String,System.String,System.String,Jellyfin.Data.Enums.ItemSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable{System.Boolean},System.Boolean)">
|
|
<summary>
|
|
Gets all artists from a given item, folder, or the entire library.
|
|
</summary>
|
|
<param name="minCommunityRating">Optional filter by minimum community rating.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="searchTerm">Optional. Search term.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="excludeItemTypes">Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="filters">Optional. Specify additional filters to apply.</param>
|
|
<param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
|
|
<param name="mediaTypes">Optional filter by MediaType. Allows multiple, comma delimited.</param>
|
|
<param name="genres">Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.</param>
|
|
<param name="genreIds">Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.</param>
|
|
<param name="officialRatings">Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.</param>
|
|
<param name="tags">Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.</param>
|
|
<param name="years">Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.</param>
|
|
<param name="enableUserData">Optional, include user data.</param>
|
|
<param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="person">Optional. If specified, results will be filtered to include only those containing the specified person.</param>
|
|
<param name="personIds">Optional. If specified, results will be filtered to include only those containing the specified person ids.</param>
|
|
<param name="personTypes">Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.</param>
|
|
<param name="studios">Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.</param>
|
|
<param name="studioIds">Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.</param>
|
|
<param name="userId">User id.</param>
|
|
<param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a given input string.</param>
|
|
<param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</param>
|
|
<param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited.</param>
|
|
<param name="sortOrder">Sort Order - Ascending,Descending.</param>
|
|
<param name="enableImages">Optional, include image information in output.</param>
|
|
<param name="enableTotalRecordCount">Total record count.</param>
|
|
<response code="200">Artists returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the artists.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ArtistsController.GetAlbumArtists(System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],MediaBrowser.Model.Querying.ItemFilter[],System.Nullable{System.Boolean},Jellyfin.Data.Enums.MediaType[],System.String[],System.Guid[],System.String[],System.String[],System.Int32[],System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.String,System.Guid[],System.String[],System.String[],System.Guid[],System.Nullable{System.Guid},System.String,System.String,System.String,Jellyfin.Data.Enums.ItemSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable{System.Boolean},System.Boolean)">
|
|
<summary>
|
|
Gets all album artists from a given item, folder, or the entire library.
|
|
</summary>
|
|
<param name="minCommunityRating">Optional filter by minimum community rating.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="searchTerm">Optional. Search term.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="excludeItemTypes">Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="filters">Optional. Specify additional filters to apply.</param>
|
|
<param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
|
|
<param name="mediaTypes">Optional filter by MediaType. Allows multiple, comma delimited.</param>
|
|
<param name="genres">Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.</param>
|
|
<param name="genreIds">Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.</param>
|
|
<param name="officialRatings">Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.</param>
|
|
<param name="tags">Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.</param>
|
|
<param name="years">Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.</param>
|
|
<param name="enableUserData">Optional, include user data.</param>
|
|
<param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="person">Optional. If specified, results will be filtered to include only those containing the specified person.</param>
|
|
<param name="personIds">Optional. If specified, results will be filtered to include only those containing the specified person ids.</param>
|
|
<param name="personTypes">Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.</param>
|
|
<param name="studios">Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.</param>
|
|
<param name="studioIds">Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.</param>
|
|
<param name="userId">User id.</param>
|
|
<param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a given input string.</param>
|
|
<param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</param>
|
|
<param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited.</param>
|
|
<param name="sortOrder">Sort Order - Ascending,Descending.</param>
|
|
<param name="enableImages">Optional, include image information in output.</param>
|
|
<param name="enableTotalRecordCount">Total record count.</param>
|
|
<response code="200">Album artists returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the album artists.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ArtistsController.GetArtistByName(System.String,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets an artist by name.
|
|
</summary>
|
|
<param name="name">Studio name.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<response code="200">Artist returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the artist.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.AudioController">
|
|
<summary>
|
|
The audio controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.AudioController.#ctor(Jellyfin.Api.Helpers.AudioHelper)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.AudioController"/> class.
|
|
</summary>
|
|
<param name="audioHelper">Instance of <see cref="T:Jellyfin.Api.Helpers.AudioHelper"/>.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.AudioController.GetAudioStream(System.Guid,System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.SubtitleDeliveryMethod},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.EncodingContext},System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean)">
|
|
<summary>
|
|
Gets an audio stream.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="container">The audio container.</param>
|
|
<param name="static">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.</param>
|
|
<param name="params">The streaming parameters.</param>
|
|
<param name="tag">The tag.</param>
|
|
<param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<param name="segmentLength">The segment length.</param>
|
|
<param name="minSegments">The minimum number of segments.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.</param>
|
|
<param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
|
|
<param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
|
|
<param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
|
|
<param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
|
|
<param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
|
|
<param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
|
|
<param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
|
|
<param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
|
|
<param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
|
|
<param name="maxRefFrames">Optional.</param>
|
|
<param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
|
|
<param name="requireAvc">Optional. Whether to require avc.</param>
|
|
<param name="deInterlace">Optional. Whether to deinterlace the video.</param>
|
|
<param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
|
|
<param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
|
|
<param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
|
|
<param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.</param>
|
|
<param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
|
|
<param name="transcodeReasons">Optional. The transcoding reason.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
|
|
<param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
|
|
<param name="context">Optional. The <see cref="T:MediaBrowser.Model.Dlna.EncodingContext"/>.</param>
|
|
<param name="streamOptions">Optional. The streaming options.</param>
|
|
<param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
|
|
<response code="200">Audio stream returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the audio file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.AudioController.GetAudioStreamByContainer(System.Guid,System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.SubtitleDeliveryMethod},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.EncodingContext},System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean)">
|
|
<summary>
|
|
Gets an audio stream.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="container">The audio container.</param>
|
|
<param name="static">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.</param>
|
|
<param name="params">The streaming parameters.</param>
|
|
<param name="tag">The tag.</param>
|
|
<param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<param name="segmentLength">The segment length.</param>
|
|
<param name="minSegments">The minimum number of segments.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.</param>
|
|
<param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
|
|
<param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
|
|
<param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
|
|
<param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
|
|
<param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
|
|
<param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
|
|
<param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
|
|
<param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
|
|
<param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
|
|
<param name="maxRefFrames">Optional.</param>
|
|
<param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
|
|
<param name="requireAvc">Optional. Whether to require avc.</param>
|
|
<param name="deInterlace">Optional. Whether to deinterlace the video.</param>
|
|
<param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
|
|
<param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
|
|
<param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
|
|
<param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.</param>
|
|
<param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
|
|
<param name="transcodeReasons">Optional. The transcoding reason.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
|
|
<param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
|
|
<param name="context">Optional. The <see cref="T:MediaBrowser.Model.Dlna.EncodingContext"/>.</param>
|
|
<param name="streamOptions">Optional. The streaming options.</param>
|
|
<param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
|
|
<response code="200">Audio stream returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the audio file.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.BackupController">
|
|
<summary>
|
|
The backup controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.BackupController.#ctor(Jellyfin.Server.Implementations.SystemBackupService.IBackupService,MediaBrowser.Common.Configuration.IApplicationPaths)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.BackupController"/> class.
|
|
</summary>
|
|
<param name="backupService">Instance of the <see cref="T:Jellyfin.Server.Implementations.SystemBackupService.IBackupService"/> interface.</param>
|
|
<param name="applicationPaths">Instance of the <see cref="T:MediaBrowser.Common.Configuration.IApplicationPaths"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.BackupController.CreateBackup(MediaBrowser.Controller.SystemBackupService.BackupOptionsDto)">
|
|
<summary>
|
|
Creates a new Backup.
|
|
</summary>
|
|
<param name="backupOptions">The backup options.</param>
|
|
<response code="200">Backup created.</response>
|
|
<response code="403">User does not have permission to retrieve information.</response>
|
|
<returns>The created backup manifest.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.BackupController.StartRestoreBackup(MediaBrowser.Controller.SystemBackupService.BackupRestoreRequestDto)">
|
|
<summary>
|
|
Restores to a backup by restarting the server and applying the backup.
|
|
</summary>
|
|
<param name="archiveRestoreDto">The data to start a restore process.</param>
|
|
<response code="204">Backup restore started.</response>
|
|
<response code="403">User does not have permission to retrieve information.</response>
|
|
<returns>No-Content.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.BackupController.ListBackups">
|
|
<summary>
|
|
Gets a list of all currently present backups in the backup directory.
|
|
</summary>
|
|
<response code="200">Backups available.</response>
|
|
<response code="403">User does not have permission to retrieve information.</response>
|
|
<returns>The list of backups.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.BackupController.GetBackup(System.String)">
|
|
<summary>
|
|
Gets the descriptor from an existing archive is present.
|
|
</summary>
|
|
<param name="path">The data to start a restore process.</param>
|
|
<response code="200">Backup archive manifest.</response>
|
|
<response code="204">Not a valid jellyfin Archive.</response>
|
|
<response code="404">Not a valid path.</response>
|
|
<response code="403">User does not have permission to retrieve information.</response>
|
|
<returns>The backup manifest.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.BrandingController">
|
|
<summary>
|
|
Branding controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.BrandingController.#ctor(MediaBrowser.Controller.Configuration.IServerConfigurationManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.BrandingController"/> class.
|
|
</summary>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.BrandingController.GetBrandingOptions">
|
|
<summary>
|
|
Gets branding configuration.
|
|
</summary>
|
|
<response code="200">Branding configuration returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the branding configuration.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.BrandingController.GetBrandingCss">
|
|
<summary>
|
|
Gets branding css.
|
|
</summary>
|
|
<response code="200">Branding css returned.</response>
|
|
<response code="204">No branding css configured.</response>
|
|
<returns>
|
|
An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the branding css if exist,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> if the css is not configured.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ChannelsController">
|
|
<summary>
|
|
Channels Controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ChannelsController.#ctor(MediaBrowser.Controller.Channels.IChannelManager,MediaBrowser.Controller.Library.IUserManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ChannelsController"/> class.
|
|
</summary>
|
|
<param name="channelManager">Instance of the <see cref="T:MediaBrowser.Controller.Channels.IChannelManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ChannelsController.GetChannels(System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Gets available channels.
|
|
</summary>
|
|
<param name="userId">User Id to filter by. Use <see cref="F:System.Guid.Empty"/> to not filter by user.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="supportsLatestItems">Optional. Filter by channels that support getting latest items.</param>
|
|
<param name="supportsMediaDeletion">Optional. Filter by channels that support media deletion.</param>
|
|
<param name="isFavorite">Optional. Filter by channels that are favorite.</param>
|
|
<response code="200">Channels returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the channels.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ChannelsController.GetAllChannelFeatures">
|
|
<summary>
|
|
Get all channel features.
|
|
</summary>
|
|
<response code="200">All channel features returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the channel features.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ChannelsController.GetChannelFeatures(System.Guid)">
|
|
<summary>
|
|
Get channel features.
|
|
</summary>
|
|
<param name="channelId">Channel id.</param>
|
|
<response code="200">Channel features returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the channel features.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ChannelsController.GetChannelItems(System.Guid,System.Nullable{System.Guid},System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32},Jellyfin.Database.Implementations.Enums.SortOrder[],MediaBrowser.Model.Querying.ItemFilter[],Jellyfin.Data.Enums.ItemSortBy[],MediaBrowser.Model.Querying.ItemFields[])">
|
|
<summary>
|
|
Get channel items.
|
|
</summary>
|
|
<param name="channelId">Channel Id.</param>
|
|
<param name="folderId">Optional. Folder Id.</param>
|
|
<param name="userId">Optional. User Id.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="sortOrder">Optional. Sort Order - Ascending,Descending.</param>
|
|
<param name="filters">Optional. Specify additional filters to apply.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<response code="200">Channel items returned.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task"/> representing the request to get the channel items.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the channel items.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ChannelsController.GetLatestChannelItems(System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFilter[],MediaBrowser.Model.Querying.ItemFields[],System.Guid[])">
|
|
<summary>
|
|
Gets latest channel items.
|
|
</summary>
|
|
<param name="userId">Optional. User Id.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="filters">Optional. Specify additional filters to apply.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="channelIds">Optional. Specify one or more channel id's, comma delimited.</param>
|
|
<response code="200">Latest channel items returned.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task"/> representing the request to get the latest channel items.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the latest channel items.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ClientLogController">
|
|
<summary>
|
|
Client log controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ClientLogController.#ctor(MediaBrowser.Controller.ClientEvent.IClientEventLogger,MediaBrowser.Controller.Configuration.IServerConfigurationManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ClientLogController"/> class.
|
|
</summary>
|
|
<param name="clientEventLogger">Instance of the <see cref="T:MediaBrowser.Controller.ClientEvent.IClientEventLogger"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ClientLogController.LogFile">
|
|
<summary>
|
|
Upload a document.
|
|
</summary>
|
|
<response code="200">Document saved.</response>
|
|
<response code="403">Event logging disabled.</response>
|
|
<response code="413">Upload size too large.</response>
|
|
<returns>Create response.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.CollectionController">
|
|
<summary>
|
|
The collection controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.CollectionController.#ctor(MediaBrowser.Controller.Collections.ICollectionManager,MediaBrowser.Controller.Dto.IDtoService)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.CollectionController"/> class.
|
|
</summary>
|
|
<param name="collectionManager">Instance of <see cref="T:MediaBrowser.Controller.Collections.ICollectionManager"/> interface.</param>
|
|
<param name="dtoService">Instance of <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.CollectionController.CreateCollection(System.String,System.String[],System.Nullable{System.Guid},System.Boolean)">
|
|
<summary>
|
|
Creates a new collection.
|
|
</summary>
|
|
<param name="name">The name of the collection.</param>
|
|
<param name="ids">Item Ids to add to the collection.</param>
|
|
<param name="parentId">Optional. Create the collection within a specific folder.</param>
|
|
<param name="isLocked">Whether or not to lock the new collection.</param>
|
|
<response code="200">Collection created.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Controller.Collections.CollectionCreationOptions"/> with information about the new collection.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.CollectionController.AddToCollection(System.Guid,System.Guid[])">
|
|
<summary>
|
|
Adds items to a collection.
|
|
</summary>
|
|
<param name="collectionId">The collection id.</param>
|
|
<param name="ids">Item ids, comma delimited.</param>
|
|
<response code="204">Items added to collection.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.CollectionController.RemoveFromCollection(System.Guid,System.Guid[])">
|
|
<summary>
|
|
Removes items from a collection.
|
|
</summary>
|
|
<param name="collectionId">The collection id.</param>
|
|
<param name="ids">Item ids, comma delimited.</param>
|
|
<response code="204">Items removed from collection.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ConfigurationController">
|
|
<summary>
|
|
Configuration Controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ConfigurationController.#ctor(MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Controller.MediaEncoding.IMediaEncoder)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ConfigurationController"/> class.
|
|
</summary>
|
|
<param name="configurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="mediaEncoder">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.IMediaEncoder"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ConfigurationController.GetConfiguration">
|
|
<summary>
|
|
Gets application configuration.
|
|
</summary>
|
|
<response code="200">Application configuration returned.</response>
|
|
<returns>Application configuration.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ConfigurationController.UpdateConfiguration(MediaBrowser.Model.Configuration.ServerConfiguration)">
|
|
<summary>
|
|
Updates application configuration.
|
|
</summary>
|
|
<param name="configuration">Configuration.</param>
|
|
<response code="204">Configuration updated.</response>
|
|
<returns>Update status.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ConfigurationController.GetNamedConfiguration(System.String)">
|
|
<summary>
|
|
Gets a named configuration.
|
|
</summary>
|
|
<param name="key">Configuration key.</param>
|
|
<response code="200">Configuration returned.</response>
|
|
<returns>Configuration.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ConfigurationController.UpdateNamedConfiguration(System.String,System.Text.Json.JsonDocument)">
|
|
<summary>
|
|
Updates named configuration.
|
|
</summary>
|
|
<param name="key">Configuration key.</param>
|
|
<param name="configuration">Configuration.</param>
|
|
<response code="204">Named configuration updated.</response>
|
|
<returns>Update status.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ConfigurationController.GetDefaultMetadataOptions">
|
|
<summary>
|
|
Gets a default MetadataOptions object.
|
|
</summary>
|
|
<response code="200">Metadata options returned.</response>
|
|
<returns>Default MetadataOptions.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ConfigurationController.UpdateBrandingConfiguration(MediaBrowser.Model.Branding.BrandingOptionsDto)">
|
|
<summary>
|
|
Updates branding configuration.
|
|
</summary>
|
|
<param name="configuration">Branding configuration.</param>
|
|
<response code="204">Branding configuration updated.</response>
|
|
<returns>Update status.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.DashboardController">
|
|
<summary>
|
|
The dashboard controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DashboardController.#ctor(Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.DashboardController},MediaBrowser.Common.Plugins.IPluginManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.DashboardController"/> class.
|
|
</summary>
|
|
<param name="logger">Instance of <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="pluginManager">Instance of <see cref="T:MediaBrowser.Common.Plugins.IPluginManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DashboardController.GetConfigurationPages(System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Gets the configuration pages.
|
|
</summary>
|
|
<param name="enableInMainMenu">Whether to enable in the main menu.</param>
|
|
<response code="200">ConfigurationPages returned.</response>
|
|
<response code="404">Server still loading.</response>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with infos about the plugins.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DashboardController.GetDashboardConfigurationPage(System.String)">
|
|
<summary>
|
|
Gets a dashboard configuration page.
|
|
</summary>
|
|
<param name="name">The name of the page.</param>
|
|
<response code="200">ConfigurationPage returned.</response>
|
|
<response code="404">Plugin configuration page not found.</response>
|
|
<returns>The configuration page.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.DatabaseViewsController">
|
|
<summary>
|
|
Exposes the PostgreSQL reporting views as read-only API endpoints.
|
|
All endpoints require administrator privileges.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DatabaseViewsController.#ctor(Microsoft.EntityFrameworkCore.IDbContextFactory{Jellyfin.Database.Implementations.JellyfinDbContext})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.DatabaseViewsController"/> class.
|
|
</summary>
|
|
<param name="dbFactory">The EF Core context factory.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DatabaseViewsController.GetMediaStreamInfos(System.Nullable{System.Guid},System.Nullable{System.Int32},System.Int32,System.Int32)">
|
|
<summary>
|
|
Gets a flat list of all media streams (audio + video columns merged).
|
|
Maps to library."MediaStreamInfos_v".
|
|
</summary>
|
|
<param name="itemId">Optional item ID filter.</param>
|
|
<param name="streamType">Optional stream type filter (0=Audio, 1=Video, 2=Subtitle).</param>
|
|
<param name="startIndex">Record index to start at.</param>
|
|
<param name="limit">Maximum records to return (1-1000, default 100).</param>
|
|
<returns>List of media stream rows.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DatabaseViewsController.GetVideoItems(System.String,System.Nullable{System.Int32},System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Gets video items joined with primary stream technical details.
|
|
Maps to library."VideoItems_v".
|
|
</summary>
|
|
<param name="type">Optional partial type filter (e.g. "Movie", "Episode").</param>
|
|
<param name="minHeight">Optional minimum video height (e.g. 2160 for 4K).</param>
|
|
<param name="hdrFormat">Optional HDR format ("Dolby Vision", "HDR10+", "HDR10", "HLG", "SDR").</param>
|
|
<param name="startIndex">Record index to start at.</param>
|
|
<param name="limit">Maximum records to return (1-1000, default 100).</param>
|
|
<returns>List of video item rows.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DatabaseViewsController.GetPlaybackHistory(System.String,System.Nullable{System.Guid},System.Boolean,System.Int32,System.Int32)">
|
|
<summary>
|
|
Gets per-user playback history with calculated progress percentages.
|
|
Maps to library."UserPlaybackHistory_v".
|
|
</summary>
|
|
<param name="username">Optional exact username filter.</param>
|
|
<param name="itemId">Optional item ID filter.</param>
|
|
<param name="inProgressOnly">When true, returns only items started but not fully played.</param>
|
|
<param name="startIndex">Record index to start at.</param>
|
|
<param name="limit">Maximum records to return (1-1000, default 100).</param>
|
|
<returns>List of playback history rows.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DatabaseViewsController.GetItemProviders(System.String,System.String,System.String,System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Gets items with their external provider IDs (IMDb, TMDB, TVDB, etc.) in named columns.
|
|
Maps to library."ItemProviders_v".
|
|
</summary>
|
|
<param name="type">Optional partial type filter.</param>
|
|
<param name="imdbId">Optional exact IMDb ID filter.</param>
|
|
<param name="tmdbId">Optional exact TMDB ID filter.</param>
|
|
<param name="tvdbId">Optional exact TVDB ID filter.</param>
|
|
<param name="startIndex">Record index to start at.</param>
|
|
<param name="limit">Maximum records to return (1-1000, default 100).</param>
|
|
<returns>List of item provider rows.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DatabaseViewsController.GetItemPeople(System.String,System.String,System.Nullable{System.Guid},System.Int32,System.Int32)">
|
|
<summary>
|
|
Gets cast and crew entries linked to the items they appear in.
|
|
Maps to library."ItemPeople_v".
|
|
</summary>
|
|
<param name="personName">Optional exact person name filter.</param>
|
|
<param name="personType">Optional person type filter (e.g. "Actor", "Director").</param>
|
|
<param name="itemId">Optional item ID filter.</param>
|
|
<param name="startIndex">Record index to start at.</param>
|
|
<param name="limit">Maximum records to return (1-1000, default 100).</param>
|
|
<returns>List of item person rows.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DatabaseViewsController.GetLibrarySummary">
|
|
<summary>
|
|
Gets aggregate library statistics - one row per item type.
|
|
Maps to library."LibrarySummary_v".
|
|
</summary>
|
|
<returns>List of library summary rows, one per item type.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.DevicesController">
|
|
<summary>
|
|
Devices Controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DevicesController.#ctor(MediaBrowser.Controller.Devices.IDeviceManager,MediaBrowser.Controller.Session.ISessionManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.DevicesController"/> class.
|
|
</summary>
|
|
<param name="deviceManager">Instance of <see cref="T:MediaBrowser.Controller.Devices.IDeviceManager"/> interface.</param>
|
|
<param name="sessionManager">Instance of <see cref="T:MediaBrowser.Controller.Session.ISessionManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DevicesController.GetDevices(System.Nullable{System.Guid})">
|
|
<summary>
|
|
Get Devices.
|
|
</summary>
|
|
<param name="userId">Gets or sets the user identifier.</param>
|
|
<response code="200">Devices retrieved.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of devices.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DevicesController.GetDeviceInfo(System.String)">
|
|
<summary>
|
|
Get info for a device.
|
|
</summary>
|
|
<param name="id">Device Id.</param>
|
|
<response code="200">Device info retrieved.</response>
|
|
<response code="404">Device not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the device info on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the device could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DevicesController.GetDeviceOptions(System.String)">
|
|
<summary>
|
|
Get options for a device.
|
|
</summary>
|
|
<param name="id">Device Id.</param>
|
|
<response code="200">Device options retrieved.</response>
|
|
<response code="404">Device not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the device info on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the device could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DevicesController.UpdateDeviceOptions(System.String,Jellyfin.Data.Dtos.DeviceOptionsDto)">
|
|
<summary>
|
|
Update device options.
|
|
</summary>
|
|
<param name="id">Device Id.</param>
|
|
<param name="deviceOptions">Device Options.</param>
|
|
<response code="204">Device options updated.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DevicesController.DeleteDevice(System.String)">
|
|
<summary>
|
|
Deletes a device.
|
|
</summary>
|
|
<param name="id">Device Id.</param>
|
|
<response code="204">Device deleted.</response>
|
|
<response code="404">Device not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the device could not be found.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.DisplayPreferencesController">
|
|
<summary>
|
|
Display Preferences Controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DisplayPreferencesController.#ctor(MediaBrowser.Controller.IDisplayPreferencesManager,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.DisplayPreferencesController})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.DisplayPreferencesController"/> class.
|
|
</summary>
|
|
<param name="displayPreferencesManager">Instance of <see cref="T:MediaBrowser.Controller.IDisplayPreferencesManager"/> interface.</param>
|
|
<param name="logger">Instance of <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DisplayPreferencesController.GetDisplayPreferences(System.String,System.Nullable{System.Guid},System.String)">
|
|
<summary>
|
|
Get Display Preferences.
|
|
</summary>
|
|
<param name="displayPreferencesId">Display preferences id.</param>
|
|
<param name="userId">User id.</param>
|
|
<param name="client">Client.</param>
|
|
<response code="200">Display preferences retrieved.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the display preferences on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the display preferences could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DisplayPreferencesController.UpdateDisplayPreferences(System.String,System.Nullable{System.Guid},System.String,MediaBrowser.Model.Dto.DisplayPreferencesDto)">
|
|
<summary>
|
|
Update Display Preferences.
|
|
</summary>
|
|
<param name="displayPreferencesId">Display preferences id.</param>
|
|
<param name="userId">User Id.</param>
|
|
<param name="client">Client.</param>
|
|
<param name="displayPreferences">New Display Preferences object.</param>
|
|
<response code="204">Display preferences updated.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.DynamicHlsController">
|
|
<summary>
|
|
Dynamic hls controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DynamicHlsController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.IMediaSourceManager,MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Controller.MediaEncoding.IMediaEncoder,MediaBrowser.Model.IO.IFileSystem,MediaBrowser.Controller.MediaEncoding.ITranscodeManager,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.DynamicHlsController},Jellyfin.Api.Helpers.DynamicHlsHelper,MediaBrowser.Controller.MediaEncoding.EncodingHelper,Jellyfin.MediaEncoding.Hls.Playlist.IDynamicHlsPlaylistGenerator)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.DynamicHlsController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="mediaSourceManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IMediaSourceManager"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="mediaEncoder">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.IMediaEncoder"/> interface.</param>
|
|
<param name="fileSystem">Instance of the <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
|
<param name="transcodeManager">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.ITranscodeManager"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="dynamicHlsHelper">Instance of <see cref="T:Jellyfin.Api.Helpers.DynamicHlsHelper"/>.</param>
|
|
<param name="encodingHelper">Instance of <see cref="T:MediaBrowser.Controller.MediaEncoding.EncodingHelper"/>.</param>
|
|
<param name="dynamicHlsPlaylistGenerator">Instance of <see cref="T:Jellyfin.MediaEncoding.Hls.Playlist.IDynamicHlsPlaylistGenerator"/>.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DynamicHlsController.GetLiveHlsStream(System.Guid,System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.SubtitleDeliveryMethod},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.EncodingContext},System.Collections.Generic.Dictionary{System.String,System.String},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Gets a hls live stream.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="container">The audio container.</param>
|
|
<param name="static">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.</param>
|
|
<param name="params">The streaming parameters.</param>
|
|
<param name="tag">The tag.</param>
|
|
<param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<param name="segmentLength">The segment length.</param>
|
|
<param name="minSegments">The minimum number of segments.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
|
|
<param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
|
|
<param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
|
|
<param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
|
|
<param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
|
|
<param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
|
|
<param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
|
|
<param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
|
|
<param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
|
|
<param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
|
|
<param name="maxRefFrames">Optional.</param>
|
|
<param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
|
|
<param name="requireAvc">Optional. Whether to require avc.</param>
|
|
<param name="deInterlace">Optional. Whether to deinterlace the video.</param>
|
|
<param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
|
|
<param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
|
|
<param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
|
|
<param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
|
|
<param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
|
|
<param name="transcodeReasons">Optional. The transcoding reason.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
|
|
<param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
|
|
<param name="context">Optional. The <see cref="T:MediaBrowser.Model.Dlna.EncodingContext"/>.</param>
|
|
<param name="streamOptions">Optional. The streaming options.</param>
|
|
<param name="maxWidth">Optional. The max width.</param>
|
|
<param name="maxHeight">Optional. The max height.</param>
|
|
<param name="enableSubtitlesInManifest">Optional. Whether to enable subtitles in the manifest.</param>
|
|
<param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
|
|
<param name="alwaysBurnInSubtitleWhenTranscoding">Whether to always burn in subtitles when transcoding.</param>
|
|
<response code="200">Hls live stream retrieved.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the hls file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DynamicHlsController.GetMasterHlsVideoPlaylist(System.Guid,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.SubtitleDeliveryMethod},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.EncodingContext},System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Gets a video hls playlist stream.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="static">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.</param>
|
|
<param name="params">The streaming parameters.</param>
|
|
<param name="tag">The tag.</param>
|
|
<param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<param name="segmentLength">The segment length.</param>
|
|
<param name="minSegments">The minimum number of segments.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
|
|
<param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
|
|
<param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
|
|
<param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
|
|
<param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
|
|
<param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
|
|
<param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
|
|
<param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
|
|
<param name="maxWidth">Optional. The maximum horizontal resolution of the encoded video.</param>
|
|
<param name="maxHeight">Optional. The maximum vertical resolution of the encoded video.</param>
|
|
<param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
|
|
<param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
|
|
<param name="maxRefFrames">Optional.</param>
|
|
<param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
|
|
<param name="requireAvc">Optional. Whether to require avc.</param>
|
|
<param name="deInterlace">Optional. Whether to deinterlace the video.</param>
|
|
<param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
|
|
<param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
|
|
<param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
|
|
<param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
|
|
<param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
|
|
<param name="transcodeReasons">Optional. The transcoding reason.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
|
|
<param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
|
|
<param name="context">Optional. The <see cref="T:MediaBrowser.Model.Dlna.EncodingContext"/>.</param>
|
|
<param name="streamOptions">Optional. The streaming options.</param>
|
|
<param name="enableAdaptiveBitrateStreaming">Enable adaptive bitrate streaming.</param>
|
|
<param name="enableTrickplay">Enable trickplay image playlists being added to master playlist.</param>
|
|
<param name="enableAudioVbrEncoding">Whether to enable Audio Encoding.</param>
|
|
<param name="alwaysBurnInSubtitleWhenTranscoding">Whether to always burn in subtitles when transcoding.</param>
|
|
<response code="200">Video stream returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the playlist file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DynamicHlsController.GetMasterHlsAudioPlaylist(System.Guid,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.SubtitleDeliveryMethod},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.EncodingContext},System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Gets an audio hls playlist stream.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="static">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.</param>
|
|
<param name="params">The streaming parameters.</param>
|
|
<param name="tag">The tag.</param>
|
|
<param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<param name="segmentLength">The segment length.</param>
|
|
<param name="minSegments">The minimum number of segments.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
|
|
<param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
|
|
<param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
|
|
<param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
|
|
<param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="maxStreamingBitrate">Optional. The maximum streaming bitrate.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
|
|
<param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
|
|
<param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
|
|
<param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
|
|
<param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
|
|
<param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
|
|
<param name="maxRefFrames">Optional.</param>
|
|
<param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
|
|
<param name="requireAvc">Optional. Whether to require avc.</param>
|
|
<param name="deInterlace">Optional. Whether to deinterlace the video.</param>
|
|
<param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
|
|
<param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
|
|
<param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
|
|
<param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
|
|
<param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
|
|
<param name="transcodeReasons">Optional. The transcoding reason.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
|
|
<param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
|
|
<param name="context">Optional. The <see cref="T:MediaBrowser.Model.Dlna.EncodingContext"/>.</param>
|
|
<param name="streamOptions">Optional. The streaming options.</param>
|
|
<param name="enableAdaptiveBitrateStreaming">Enable adaptive bitrate streaming.</param>
|
|
<param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
|
|
<response code="200">Audio stream returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the playlist file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DynamicHlsController.GetVariantHlsVideoPlaylist(System.Guid,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.SubtitleDeliveryMethod},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.EncodingContext},System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Gets a video stream using HTTP live streaming.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="static">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.</param>
|
|
<param name="params">The streaming parameters.</param>
|
|
<param name="tag">The tag.</param>
|
|
<param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<param name="segmentLength">The segment length.</param>
|
|
<param name="minSegments">The minimum number of segments.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
|
|
<param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
|
|
<param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
|
|
<param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
|
|
<param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
|
|
<param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
|
|
<param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
|
|
<param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
|
|
<param name="maxWidth">Optional. The maximum horizontal resolution of the encoded video.</param>
|
|
<param name="maxHeight">Optional. The maximum vertical resolution of the encoded video.</param>
|
|
<param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
|
|
<param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
|
|
<param name="maxRefFrames">Optional.</param>
|
|
<param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
|
|
<param name="requireAvc">Optional. Whether to require avc.</param>
|
|
<param name="deInterlace">Optional. Whether to deinterlace the video.</param>
|
|
<param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
|
|
<param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
|
|
<param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
|
|
<param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
|
|
<param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
|
|
<param name="transcodeReasons">Optional. The transcoding reason.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
|
|
<param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
|
|
<param name="context">Optional. The <see cref="T:MediaBrowser.Model.Dlna.EncodingContext"/>.</param>
|
|
<param name="streamOptions">Optional. The streaming options.</param>
|
|
<param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
|
|
<param name="alwaysBurnInSubtitleWhenTranscoding">Whether to always burn in subtitles when transcoding.</param>
|
|
<response code="200">Video stream returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the audio file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DynamicHlsController.GetVariantHlsAudioPlaylist(System.Guid,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.SubtitleDeliveryMethod},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.EncodingContext},System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean)">
|
|
<summary>
|
|
Gets an audio stream using HTTP live streaming.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="static">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.</param>
|
|
<param name="params">The streaming parameters.</param>
|
|
<param name="tag">The tag.</param>
|
|
<param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<param name="segmentLength">The segment length.</param>
|
|
<param name="minSegments">The minimum number of segments.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
|
|
<param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
|
|
<param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
|
|
<param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
|
|
<param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="maxStreamingBitrate">Optional. The maximum streaming bitrate.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
|
|
<param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
|
|
<param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
|
|
<param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
|
|
<param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
|
|
<param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
|
|
<param name="maxRefFrames">Optional.</param>
|
|
<param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
|
|
<param name="requireAvc">Optional. Whether to require avc.</param>
|
|
<param name="deInterlace">Optional. Whether to deinterlace the video.</param>
|
|
<param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
|
|
<param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
|
|
<param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
|
|
<param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
|
|
<param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
|
|
<param name="transcodeReasons">Optional. The transcoding reason.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
|
|
<param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
|
|
<param name="context">Optional. The <see cref="T:MediaBrowser.Model.Dlna.EncodingContext"/>.</param>
|
|
<param name="streamOptions">Optional. The streaming options.</param>
|
|
<param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
|
|
<response code="200">Audio stream returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the audio file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DynamicHlsController.GetHlsVideoSegment(System.Guid,System.String,System.Int32,System.String,System.Int64,System.Int64,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.SubtitleDeliveryMethod},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.EncodingContext},System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Gets a video stream using HTTP live streaming.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<param name="segmentId">The segment id.</param>
|
|
<param name="container">The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. </param>
|
|
<param name="runtimeTicks">The position of the requested segment in ticks.</param>
|
|
<param name="actualSegmentLengthTicks">The length of the requested segment in ticks.</param>
|
|
<param name="static">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.</param>
|
|
<param name="params">The streaming parameters.</param>
|
|
<param name="tag">The tag.</param>
|
|
<param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<param name="segmentLength">The desired segment length.</param>
|
|
<param name="minSegments">The minimum number of segments.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
|
|
<param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
|
|
<param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
|
|
<param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
|
|
<param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
|
|
<param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
|
|
<param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
|
|
<param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
|
|
<param name="maxWidth">Optional. The maximum horizontal resolution of the encoded video.</param>
|
|
<param name="maxHeight">Optional. The maximum vertical resolution of the encoded video.</param>
|
|
<param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
|
|
<param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
|
|
<param name="maxRefFrames">Optional.</param>
|
|
<param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
|
|
<param name="requireAvc">Optional. Whether to require avc.</param>
|
|
<param name="deInterlace">Optional. Whether to deinterlace the video.</param>
|
|
<param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
|
|
<param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
|
|
<param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
|
|
<param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
|
|
<param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
|
|
<param name="transcodeReasons">Optional. The transcoding reason.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
|
|
<param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
|
|
<param name="context">Optional. The <see cref="T:MediaBrowser.Model.Dlna.EncodingContext"/>.</param>
|
|
<param name="streamOptions">Optional. The streaming options.</param>
|
|
<param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
|
|
<param name="alwaysBurnInSubtitleWhenTranscoding">Whether to always burn in subtitles when transcoding.</param>
|
|
<response code="200">Video stream returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the audio file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DynamicHlsController.GetHlsAudioSegment(System.Guid,System.String,System.Int32,System.String,System.Int64,System.Int64,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.SubtitleDeliveryMethod},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.EncodingContext},System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean)">
|
|
<summary>
|
|
Gets a video stream using HTTP live streaming.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<param name="segmentId">The segment id.</param>
|
|
<param name="container">The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. </param>
|
|
<param name="runtimeTicks">The position of the requested segment in ticks.</param>
|
|
<param name="actualSegmentLengthTicks">The length of the requested segment in ticks.</param>
|
|
<param name="static">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.</param>
|
|
<param name="params">The streaming parameters.</param>
|
|
<param name="tag">The tag.</param>
|
|
<param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<param name="segmentLength">The segment length.</param>
|
|
<param name="minSegments">The minimum number of segments.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
|
|
<param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
|
|
<param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
|
|
<param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
|
|
<param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="maxStreamingBitrate">Optional. The maximum streaming bitrate.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
|
|
<param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
|
|
<param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
|
|
<param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
|
|
<param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
|
|
<param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
|
|
<param name="maxRefFrames">Optional.</param>
|
|
<param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
|
|
<param name="requireAvc">Optional. Whether to require avc.</param>
|
|
<param name="deInterlace">Optional. Whether to deinterlace the video.</param>
|
|
<param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
|
|
<param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
|
|
<param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
|
|
<param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
|
|
<param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
|
|
<param name="transcodeReasons">Optional. The transcoding reason.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
|
|
<param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
|
|
<param name="context">Optional. The <see cref="T:MediaBrowser.Model.Dlna.EncodingContext"/>.</param>
|
|
<param name="streamOptions">Optional. The streaming options.</param>
|
|
<param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
|
|
<response code="200">Video stream returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the audio file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DynamicHlsController.GetAudioArguments(MediaBrowser.Controller.Streaming.StreamState)">
|
|
<summary>
|
|
Gets the audio arguments for transcoding.
|
|
</summary>
|
|
<param name="state">The <see cref="T:MediaBrowser.Controller.Streaming.StreamState"/>.</param>
|
|
<returns>The command line arguments for audio transcoding.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.DynamicHlsController.GetVideoArguments(MediaBrowser.Controller.Streaming.StreamState,System.Int32,System.Boolean,System.String)">
|
|
<summary>
|
|
Gets the video arguments for transcoding.
|
|
</summary>
|
|
<param name="state">The <see cref="T:MediaBrowser.Controller.Streaming.StreamState"/>.</param>
|
|
<param name="startNumber">The first number in the hls sequence.</param>
|
|
<param name="isEventPlaylist">Whether the playlist is EVENT or VOD.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<returns>The command line arguments for video transcoding.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.EnvironmentController">
|
|
<summary>
|
|
Environment Controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.EnvironmentController.#ctor(MediaBrowser.Model.IO.IFileSystem,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.EnvironmentController})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.EnvironmentController"/> class.
|
|
</summary>
|
|
<param name="fileSystem">Instance of the <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.EnvironmentController.GetDirectoryContents(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Gets the contents of a given directory in the file system.
|
|
</summary>
|
|
<param name="path">The path.</param>
|
|
<param name="includeFiles">An optional filter to include or exclude files from the results. true/false.</param>
|
|
<param name="includeDirectories">An optional filter to include or exclude folders from the results. true/false.</param>
|
|
<response code="200">Directory contents returned.</response>
|
|
<returns>Directory contents.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.EnvironmentController.ValidatePath(Jellyfin.Api.Models.EnvironmentDtos.ValidatePathDto)">
|
|
<summary>
|
|
Validates path.
|
|
</summary>
|
|
<param name="validatePathDto">Validate request object.</param>
|
|
<response code="204">Path validated.</response>
|
|
<response code="404">Path not found.</response>
|
|
<returns>Validation status.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.EnvironmentController.GetDrives">
|
|
<summary>
|
|
Gets available drives from the server's file system.
|
|
</summary>
|
|
<response code="200">List of entries returned.</response>
|
|
<returns>List of entries.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.EnvironmentController.GetParentPath(System.String)">
|
|
<summary>
|
|
Gets the parent path of a given path.
|
|
</summary>
|
|
<param name="path">The path.</param>
|
|
<returns>Parent path.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.EnvironmentController.GetDefaultDirectoryBrowser">
|
|
<summary>
|
|
Get Default directory browser.
|
|
</summary>
|
|
<response code="200">Default directory browser returned.</response>
|
|
<returns>Default directory browser.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.FilterController">
|
|
<summary>
|
|
Filters controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.FilterController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.FilterController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.FilterController.GetQueryFiltersLegacy(System.Nullable{System.Guid},System.Nullable{System.Guid},Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.MediaType[])">
|
|
<summary>
|
|
Gets legacy query filters.
|
|
</summary>
|
|
<param name="userId">Optional. User id.</param>
|
|
<param name="parentId">Optional. Parent id.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="mediaTypes">Optional. Filter by MediaType. Allows multiple, comma delimited.</param>
|
|
<response code="200">Legacy filters retrieved.</response>
|
|
<returns>Legacy query filters.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.FilterController.GetQueryFilters(System.Nullable{System.Guid},System.Nullable{System.Guid},Jellyfin.Data.Enums.BaseItemKind[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Gets query filters.
|
|
</summary>
|
|
<param name="userId">Optional. User id.</param>
|
|
<param name="parentId">Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="isAiring">Optional. Is item airing.</param>
|
|
<param name="isMovie">Optional. Is item movie.</param>
|
|
<param name="isSports">Optional. Is item sports.</param>
|
|
<param name="isKids">Optional. Is item kids.</param>
|
|
<param name="isNews">Optional. Is item news.</param>
|
|
<param name="isSeries">Optional. Is item series.</param>
|
|
<param name="recursive">Optional. Search recursive.</param>
|
|
<response code="200">Filters retrieved.</response>
|
|
<returns>Query filters.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.GenresController">
|
|
<summary>
|
|
The genres controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.GenresController.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Dto.IDtoService)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.GenresController"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.GenresController.GetGenres(System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Nullable{System.Guid},System.String,System.String,System.String,Jellyfin.Data.Enums.ItemSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable{System.Boolean},System.Boolean)">
|
|
<summary>
|
|
Gets all genres from a given item, folder, or the entire library.
|
|
</summary>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="searchTerm">The search term.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="excludeItemTypes">Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
|
|
<param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="userId">User id.</param>
|
|
<param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a given input string.</param>
|
|
<param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</param>
|
|
<param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited.</param>
|
|
<param name="sortOrder">Sort Order - Ascending,Descending.</param>
|
|
<param name="enableImages">Optional, include image information in output.</param>
|
|
<param name="enableTotalRecordCount">Optional. Include total record count.</param>
|
|
<response code="200">Genres returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the queryresult of genres.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.GenresController.GetGenre(System.String,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets a genre, by name.
|
|
</summary>
|
|
<param name="genreName">The genre name.</param>
|
|
<param name="userId">The user id.</param>
|
|
<response code="200">Genres returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the genre.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.HlsSegmentController">
|
|
<summary>
|
|
The hls segment controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.HlsSegmentController.#ctor(MediaBrowser.Model.IO.IFileSystem,MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Controller.MediaEncoding.ITranscodeManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.HlsSegmentController"/> class.
|
|
</summary>
|
|
<param name="fileSystem">Instance of the <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="transcodeManager">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.ITranscodeManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.HlsSegmentController.GetHlsAudioSegmentLegacy(System.String,System.String)">
|
|
<summary>
|
|
Gets the specified audio segment for an audio item.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="segmentId">The segment id.</param>
|
|
<response code="200">Hls audio segment returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the audio stream.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.HlsSegmentController.GetHlsPlaylistLegacy(System.String,System.String)">
|
|
<summary>
|
|
Gets a hls video playlist.
|
|
</summary>
|
|
<param name="itemId">The video id.</param>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<response code="200">Hls video playlist returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the playlist.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.HlsSegmentController.StopEncodingProcess(System.String,System.String)">
|
|
<summary>
|
|
Stops an active encoding.
|
|
</summary>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<response code="204">Encoding stopped successfully.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.HlsSegmentController.GetHlsVideoSegmentLegacy(System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
Gets a hls video segment.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<param name="segmentId">The segment id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<response code="200">Hls video segment returned.</response>
|
|
<response code="404">Hls segment not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the video segment.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ImageController">
|
|
<summary>
|
|
Image controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Providers.IProviderManager,MediaBrowser.Controller.Drawing.IImageProcessor,MediaBrowser.Model.IO.IFileSystem,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.ImageController},MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Common.Configuration.IApplicationPaths)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ImageController"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="providerManager">Instance of the <see cref="T:MediaBrowser.Controller.Providers.IProviderManager"/> interface.</param>
|
|
<param name="imageProcessor">Instance of the <see cref="T:MediaBrowser.Controller.Drawing.IImageProcessor"/> interface.</param>
|
|
<param name="fileSystem">Instance of the <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="appPaths">Instance of the <see cref="T:MediaBrowser.Common.Configuration.IApplicationPaths"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.PostUserImage(System.Nullable{System.Guid})">
|
|
<summary>
|
|
Sets the user image.
|
|
</summary>
|
|
<param name="userId">User Id.</param>
|
|
<response code="204">Image updated.</response>
|
|
<response code="403">User does not have permission to delete the image.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.PostUserImageLegacy(System.Guid,MediaBrowser.Model.Entities.ImageType)">
|
|
<summary>
|
|
Sets the user image.
|
|
</summary>
|
|
<param name="userId">User Id.</param>
|
|
<param name="imageType">(Unused) Image type.</param>
|
|
<response code="204">Image updated.</response>
|
|
<response code="403">User does not have permission to delete the image.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.PostUserImageByIndexLegacy(System.Guid,MediaBrowser.Model.Entities.ImageType,System.Int32)">
|
|
<summary>
|
|
Sets the user image.
|
|
</summary>
|
|
<param name="userId">User Id.</param>
|
|
<param name="imageType">(Unused) Image type.</param>
|
|
<param name="index">(Unused) Image index.</param>
|
|
<response code="204">Image updated.</response>
|
|
<response code="403">User does not have permission to delete the image.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.DeleteUserImage(System.Nullable{System.Guid})">
|
|
<summary>
|
|
Delete the user's image.
|
|
</summary>
|
|
<param name="userId">User Id.</param>
|
|
<response code="204">Image deleted.</response>
|
|
<response code="403">User does not have permission to delete the image.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.DeleteUserImageLegacy(System.Guid,MediaBrowser.Model.Entities.ImageType,System.Nullable{System.Int32})">
|
|
<summary>
|
|
Delete the user's image.
|
|
</summary>
|
|
<param name="userId">User Id.</param>
|
|
<param name="imageType">(Unused) Image type.</param>
|
|
<param name="index">(Unused) Image index.</param>
|
|
<response code="204">Image deleted.</response>
|
|
<response code="403">User does not have permission to delete the image.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.DeleteUserImageByIndexLegacy(System.Guid,MediaBrowser.Model.Entities.ImageType,System.Int32)">
|
|
<summary>
|
|
Delete the user's image.
|
|
</summary>
|
|
<param name="userId">User Id.</param>
|
|
<param name="imageType">(Unused) Image type.</param>
|
|
<param name="index">(Unused) Image index.</param>
|
|
<response code="204">Image deleted.</response>
|
|
<response code="403">User does not have permission to delete the image.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.DeleteItemImage(System.Guid,MediaBrowser.Model.Entities.ImageType,System.Nullable{System.Int32})">
|
|
<summary>
|
|
Delete an item's image.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="imageIndex">The image index.</param>
|
|
<response code="204">Image deleted.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.DeleteItemImageByIndex(System.Guid,MediaBrowser.Model.Entities.ImageType,System.Int32)">
|
|
<summary>
|
|
Delete an item's image.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="imageIndex">The image index.</param>
|
|
<response code="204">Image deleted.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.SetItemImage(System.Guid,MediaBrowser.Model.Entities.ImageType)">
|
|
<summary>
|
|
Set item image.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<response code="204">Image saved.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.SetItemImageByIndex(System.Guid,MediaBrowser.Model.Entities.ImageType,System.Int32)">
|
|
<summary>
|
|
Set item image.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="imageIndex">(Unused) Image index.</param>
|
|
<response code="204">Image saved.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.UpdateItemImageIndex(System.Guid,MediaBrowser.Model.Entities.ImageType,System.Int32,System.Int32)">
|
|
<summary>
|
|
Updates the index for an item image.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="imageIndex">Old image index.</param>
|
|
<param name="newIndex">New image index.</param>
|
|
<response code="204">Image index updated.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetItemImageInfos(System.Guid)">
|
|
<summary>
|
|
Get item image infos.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Item images returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>The list of image infos on success, or <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetItemImage(System.Guid,MediaBrowser.Model.Entities.ImageType,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Int32})">
|
|
<summary>
|
|
Gets the item's image.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Optional. The <see cref="T:MediaBrowser.Model.Drawing.ImageFormat"/> of the returned image.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetItemImageByIndex(System.Guid,MediaBrowser.Model.Entities.ImageType,System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String)">
|
|
<summary>
|
|
Gets the item's image.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Optional. The <see cref="T:MediaBrowser.Model.Drawing.ImageFormat"/> of the returned image.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetItemImage2(System.Guid,MediaBrowser.Model.Entities.ImageType,System.Int32,System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,MediaBrowser.Model.Drawing.ImageFormat,System.Double,System.Int32,System.Nullable{System.Int32},System.String,System.String,System.Int32)">
|
|
<summary>
|
|
Gets the item's image.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetArtistImage(System.String,MediaBrowser.Model.Entities.ImageType,System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Int32)">
|
|
<summary>
|
|
Get artist image by name.
|
|
</summary>
|
|
<param name="name">Artist name.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetGenreImage(System.String,MediaBrowser.Model.Entities.ImageType,System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get genre image by name.
|
|
</summary>
|
|
<param name="name">Genre name.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetGenreImageByIndex(System.String,MediaBrowser.Model.Entities.ImageType,System.Int32,System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String)">
|
|
<summary>
|
|
Get genre image by name.
|
|
</summary>
|
|
<param name="name">Genre name.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetMusicGenreImage(System.String,MediaBrowser.Model.Entities.ImageType,System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get music genre image by name.
|
|
</summary>
|
|
<param name="name">Music genre name.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetMusicGenreImageByIndex(System.String,MediaBrowser.Model.Entities.ImageType,System.Int32,System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String)">
|
|
<summary>
|
|
Get music genre image by name.
|
|
</summary>
|
|
<param name="name">Music genre name.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetPersonImage(System.String,MediaBrowser.Model.Entities.ImageType,System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get person image by name.
|
|
</summary>
|
|
<param name="name">Person name.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetPersonImageByIndex(System.String,MediaBrowser.Model.Entities.ImageType,System.Int32,System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String)">
|
|
<summary>
|
|
Get person image by name.
|
|
</summary>
|
|
<param name="name">Person name.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetStudioImage(System.String,MediaBrowser.Model.Entities.ImageType,System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get studio image by name.
|
|
</summary>
|
|
<param name="name">Studio name.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetStudioImageByIndex(System.String,MediaBrowser.Model.Entities.ImageType,System.Int32,System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String)">
|
|
<summary>
|
|
Get studio image by name.
|
|
</summary>
|
|
<param name="name">Studio name.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetUserImage(System.Nullable{System.Guid},System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat})">
|
|
<summary>
|
|
Get user profile image.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="400">User id not provided.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetUserImageLegacy(System.Guid,MediaBrowser.Model.Entities.ImageType,System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get user profile image.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetUserImageByIndexLegacy(System.Guid,MediaBrowser.Model.Entities.ImageType,System.Int32,System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String)">
|
|
<summary>
|
|
Get user profile image.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="imageType">Image type.</param>
|
|
<param name="imageIndex">Image index.</param>
|
|
<param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<param name="maxWidth">The maximum image width to return.</param>
|
|
<param name="maxHeight">The maximum image height to return.</param>
|
|
<param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
<param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
<param name="width">The fixed image width to return.</param>
|
|
<param name="height">The fixed image height to return.</param>
|
|
<param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
<param name="fillWidth">Width of box to fill.</param>
|
|
<param name="fillHeight">Height of box to fill.</param>
|
|
<param name="blur">Optional. Blur image.</param>
|
|
<param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
<param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
<response code="200">Image stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the file stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.GetSplashscreen(System.String,System.Nullable{MediaBrowser.Model.Drawing.ImageFormat})">
|
|
<summary>
|
|
Generates or gets the splashscreen.
|
|
</summary>
|
|
<param name="tag">Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
<param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
<response code="200">Splashscreen returned successfully.</response>
|
|
<returns>The splashscreen.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.UploadCustomSplashscreen">
|
|
<summary>
|
|
Uploads a custom splashscreen.
|
|
The body is expected to the image contents base64 encoded.
|
|
</summary>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
<response code="204">Successfully uploaded new splashscreen.</response>
|
|
<response code="400">Error reading MimeType from uploaded image.</response>
|
|
<response code="403">User does not have permission to upload splashscreen..</response>
|
|
<exception cref="T:System.ArgumentException">Error reading the image format.</exception>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ImageController.DeleteCustomSplashscreen">
|
|
<summary>
|
|
Delete a custom splashscreen.
|
|
</summary>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
<response code="204">Successfully deleted the custom splashscreen.</response>
|
|
<response code="403">User does not have permission to delete splashscreen..</response>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.InstantMixController">
|
|
<summary>
|
|
The instant mix controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.InstantMixController.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Library.IMusicManager,MediaBrowser.Controller.Library.ILibraryManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.InstantMixController"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="musicManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IMusicManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.InstantMixController.GetInstantMixFromSong(System.Guid,System.Nullable{System.Guid},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[])">
|
|
<summary>
|
|
Creates an instant playlist based on a given song.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<response code="200">Instant playlist returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the playlist items.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.InstantMixController.GetInstantMixFromAlbum(System.Guid,System.Nullable{System.Guid},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[])">
|
|
<summary>
|
|
Creates an instant playlist based on a given album.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<response code="200">Instant playlist returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the playlist items.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.InstantMixController.GetInstantMixFromPlaylist(System.Guid,System.Nullable{System.Guid},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[])">
|
|
<summary>
|
|
Creates an instant playlist based on a given playlist.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<response code="200">Instant playlist returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the playlist items.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.InstantMixController.GetInstantMixFromMusicGenreByName(System.String,System.Nullable{System.Guid},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[])">
|
|
<summary>
|
|
Creates an instant playlist based on a given genre.
|
|
</summary>
|
|
<param name="name">The genre name.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<response code="200">Instant playlist returned.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the playlist items.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.InstantMixController.GetInstantMixFromArtists(System.Guid,System.Nullable{System.Guid},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[])">
|
|
<summary>
|
|
Creates an instant playlist based on a given artist.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<response code="200">Instant playlist returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the playlist items.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.InstantMixController.GetInstantMixFromItem(System.Guid,System.Nullable{System.Guid},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[])">
|
|
<summary>
|
|
Creates an instant playlist based on a given item.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<response code="200">Instant playlist returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the playlist items.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.InstantMixController.GetInstantMixFromArtists2(System.Guid,System.Nullable{System.Guid},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[])">
|
|
<summary>
|
|
Creates an instant playlist based on a given artist.
|
|
</summary>
|
|
<param name="id">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<response code="200">Instant playlist returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the playlist items.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.InstantMixController.GetInstantMixFromMusicGenreById(System.Guid,System.Nullable{System.Guid},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[])">
|
|
<summary>
|
|
Creates an instant playlist based on a given genre.
|
|
</summary>
|
|
<param name="id">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<response code="200">Instant playlist returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the playlist items.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ItemLookupController">
|
|
<summary>
|
|
Item lookup controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.#ctor(MediaBrowser.Controller.Providers.IProviderManager,MediaBrowser.Model.IO.IFileSystem,MediaBrowser.Controller.Library.ILibraryManager,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.ItemLookupController})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ItemLookupController"/> class.
|
|
</summary>
|
|
<param name="providerManager">Instance of the <see cref="T:MediaBrowser.Controller.Providers.IProviderManager"/> interface.</param>
|
|
<param name="fileSystem">Instance of the <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.GetExternalIdInfos(System.Guid)">
|
|
<summary>
|
|
Get the item's external id info.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">External id info retrieved.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>List of external id info.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.GetMovieRemoteSearchResults(MediaBrowser.Controller.Providers.RemoteSearchQuery{MediaBrowser.Controller.Providers.MovieInfo})">
|
|
<summary>
|
|
Get movie remote search.
|
|
</summary>
|
|
<param name="query">Remote search query.</param>
|
|
<response code="200">Movie remote search executed.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to get the remote search results.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of remote search results.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.GetTrailerRemoteSearchResults(MediaBrowser.Controller.Providers.RemoteSearchQuery{MediaBrowser.Controller.Providers.TrailerInfo})">
|
|
<summary>
|
|
Get trailer remote search.
|
|
</summary>
|
|
<param name="query">Remote search query.</param>
|
|
<response code="200">Trailer remote search executed.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to get the remote search results.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of remote search results.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.GetMusicVideoRemoteSearchResults(MediaBrowser.Controller.Providers.RemoteSearchQuery{MediaBrowser.Controller.Providers.MusicVideoInfo})">
|
|
<summary>
|
|
Get music video remote search.
|
|
</summary>
|
|
<param name="query">Remote search query.</param>
|
|
<response code="200">Music video remote search executed.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to get the remote search results.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of remote search results.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.GetSeriesRemoteSearchResults(MediaBrowser.Controller.Providers.RemoteSearchQuery{MediaBrowser.Controller.Providers.SeriesInfo})">
|
|
<summary>
|
|
Get series remote search.
|
|
</summary>
|
|
<param name="query">Remote search query.</param>
|
|
<response code="200">Series remote search executed.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to get the remote search results.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of remote search results.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.GetBoxSetRemoteSearchResults(MediaBrowser.Controller.Providers.RemoteSearchQuery{MediaBrowser.Controller.Providers.BoxSetInfo})">
|
|
<summary>
|
|
Get box set remote search.
|
|
</summary>
|
|
<param name="query">Remote search query.</param>
|
|
<response code="200">Box set remote search executed.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to get the remote search results.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of remote search results.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.GetMusicArtistRemoteSearchResults(MediaBrowser.Controller.Providers.RemoteSearchQuery{MediaBrowser.Controller.Providers.ArtistInfo})">
|
|
<summary>
|
|
Get music artist remote search.
|
|
</summary>
|
|
<param name="query">Remote search query.</param>
|
|
<response code="200">Music artist remote search executed.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to get the remote search results.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of remote search results.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.GetMusicAlbumRemoteSearchResults(MediaBrowser.Controller.Providers.RemoteSearchQuery{MediaBrowser.Controller.Providers.AlbumInfo})">
|
|
<summary>
|
|
Get music album remote search.
|
|
</summary>
|
|
<param name="query">Remote search query.</param>
|
|
<response code="200">Music album remote search executed.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to get the remote search results.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of remote search results.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.GetPersonRemoteSearchResults(MediaBrowser.Controller.Providers.RemoteSearchQuery{MediaBrowser.Controller.Providers.PersonLookupInfo})">
|
|
<summary>
|
|
Get person remote search.
|
|
</summary>
|
|
<param name="query">Remote search query.</param>
|
|
<response code="200">Person remote search executed.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to get the remote search results.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of remote search results.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.GetBookRemoteSearchResults(MediaBrowser.Controller.Providers.RemoteSearchQuery{MediaBrowser.Controller.Providers.BookInfo})">
|
|
<summary>
|
|
Get book remote search.
|
|
</summary>
|
|
<param name="query">Remote search query.</param>
|
|
<response code="200">Book remote search executed.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to get the remote search results.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of remote search results.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemLookupController.ApplySearchCriteria(System.Guid,MediaBrowser.Model.Providers.RemoteSearchResult,System.Boolean)">
|
|
<summary>
|
|
Applies search criteria to an item and refreshes metadata.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="searchResult">The remote search result.</param>
|
|
<param name="replaceAllImages">Optional. Whether or not to replace all images. Default: True.</param>
|
|
<response code="204">Item metadata refreshed.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to get the remote search results.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ItemRefreshController">
|
|
<summary>
|
|
Item Refresh Controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemRefreshController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Providers.IProviderManager,MediaBrowser.Model.IO.IFileSystem)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ItemRefreshController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="providerManager">Instance of <see cref="T:MediaBrowser.Controller.Providers.IProviderManager"/> interface.</param>
|
|
<param name="fileSystem">Instance of <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemRefreshController.RefreshItem(System.Guid,MediaBrowser.Controller.Providers.MetadataRefreshMode,MediaBrowser.Controller.Providers.MetadataRefreshMode,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Refreshes metadata for an item.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="metadataRefreshMode">(Optional) Specifies the metadata refresh mode.</param>
|
|
<param name="imageRefreshMode">(Optional) Specifies the image refresh mode.</param>
|
|
<param name="replaceAllMetadata">(Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.</param>
|
|
<param name="replaceAllImages">(Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.</param>
|
|
<param name="regenerateTrickplay">(Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh.</param>
|
|
<response code="204">Item metadata refresh queued.</response>
|
|
<response code="404">Item to refresh not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the item could not be found.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ItemsController">
|
|
<summary>
|
|
The items controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemsController.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Model.Globalization.ILocalizationManager,MediaBrowser.Controller.Dto.IDtoService,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.ItemsController},MediaBrowser.Controller.Session.ISessionManager,MediaBrowser.Controller.Library.IUserDataManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ItemsController"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="localization">Instance of the <see cref="T:MediaBrowser.Model.Globalization.ILocalizationManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger"/> interface.</param>
|
|
<param name="sessionManager">Instance of the <see cref="T:MediaBrowser.Controller.Session.ISessionManager"/> interface.</param>
|
|
<param name="userDataRepository">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserDataManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemsController.GetItems(System.Nullable{System.Guid},System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},MediaBrowser.Model.Entities.LocationType[],MediaBrowser.Model.Entities.LocationType[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Guid[],System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.String,Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],MediaBrowser.Model.Querying.ItemFilter[],System.Nullable{System.Boolean},Jellyfin.Data.Enums.MediaType[],MediaBrowser.Model.Entities.ImageType[],Jellyfin.Data.Enums.ItemSortBy[],System.Nullable{System.Boolean},System.String[],System.String[],System.String[],System.Int32[],System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.String,System.Guid[],System.String[],System.String[],System.String[],System.Guid[],System.Guid[],System.Guid[],System.Guid[],System.String[],System.Guid[],System.Guid[],MediaBrowser.Model.Entities.VideoType[],System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},MediaBrowser.Model.Entities.SeriesStatus[],System.String,System.String,System.String,System.Guid[],System.Guid[],System.Boolean,System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Gets items based on a query.
|
|
</summary>
|
|
<param name="userId">The user id supplied as query parameter; this is required when not using an API key.</param>
|
|
<param name="maxOfficialRating">Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).</param>
|
|
<param name="hasThemeSong">Optional filter by items with theme songs.</param>
|
|
<param name="hasThemeVideo">Optional filter by items with theme videos.</param>
|
|
<param name="hasSubtitles">Optional filter by items with subtitles.</param>
|
|
<param name="hasSpecialFeature">Optional filter by items with special features.</param>
|
|
<param name="hasTrailer">Optional filter by items with trailers.</param>
|
|
<param name="adjacentTo">Optional. Return items that are siblings of a supplied item.</param>
|
|
<param name="indexNumber">Optional filter by index number.</param>
|
|
<param name="parentIndexNumber">Optional filter by parent index number.</param>
|
|
<param name="hasParentalRating">Optional filter by items that have or do not have a parental rating.</param>
|
|
<param name="isHd">Optional filter by items that are HD or not.</param>
|
|
<param name="is4K">Optional filter by items that are 4K or not.</param>
|
|
<param name="locationTypes">Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.</param>
|
|
<param name="excludeLocationTypes">Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.</param>
|
|
<param name="isMissing">Optional filter by items that are missing episodes or not.</param>
|
|
<param name="isUnaired">Optional filter by items that are unaired episodes or not.</param>
|
|
<param name="minCommunityRating">Optional filter by minimum community rating.</param>
|
|
<param name="minCriticRating">Optional filter by minimum critic rating.</param>
|
|
<param name="minPremiereDate">Optional. The minimum premiere date. Format = ISO.</param>
|
|
<param name="minDateLastSaved">Optional. The minimum last saved date. Format = ISO.</param>
|
|
<param name="minDateLastSavedForUser">Optional. The minimum last saved date for the current user. Format = ISO.</param>
|
|
<param name="maxPremiereDate">Optional. The maximum premiere date. Format = ISO.</param>
|
|
<param name="hasOverview">Optional filter by items that have an overview or not.</param>
|
|
<param name="hasImdbId">Optional filter by items that have an IMDb id or not.</param>
|
|
<param name="hasTmdbId">Optional filter by items that have a TMDb id or not.</param>
|
|
<param name="hasTvdbId">Optional filter by items that have a TVDb id or not.</param>
|
|
<param name="isMovie">Optional filter for live tv movies.</param>
|
|
<param name="isSeries">Optional filter for live tv series.</param>
|
|
<param name="isNews">Optional filter for live tv news.</param>
|
|
<param name="isKids">Optional filter for live tv kids.</param>
|
|
<param name="isSports">Optional filter for live tv sports.</param>
|
|
<param name="excludeItemIds">Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="recursive">When searching within folders, this determines whether or not the search will be recursive. true/false.</param>
|
|
<param name="searchTerm">Optional. Filter based on a search term.</param>
|
|
<param name="sortOrder">Sort Order - Ascending, Descending.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. 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.</param>
|
|
<param name="excludeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.</param>
|
|
<param name="filters">Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.</param>
|
|
<param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
|
|
<param name="mediaTypes">Optional filter by MediaType. Allows multiple, comma delimited.</param>
|
|
<param name="imageTypes">Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
|
<param name="isPlayed">Optional filter by items that are played, or not.</param>
|
|
<param name="genres">Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.</param>
|
|
<param name="officialRatings">Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.</param>
|
|
<param name="tags">Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.</param>
|
|
<param name="years">Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.</param>
|
|
<param name="enableUserData">Optional, include user data.</param>
|
|
<param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="person">Optional. If specified, results will be filtered to include only those containing the specified person.</param>
|
|
<param name="personIds">Optional. If specified, results will be filtered to include only those containing the specified person id.</param>
|
|
<param name="personTypes">Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.</param>
|
|
<param name="studios">Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.</param>
|
|
<param name="artists">Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.</param>
|
|
<param name="excludeArtistIds">Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.</param>
|
|
<param name="artistIds">Optional. If specified, results will be filtered to include only those containing the specified artist id.</param>
|
|
<param name="albumArtistIds">Optional. If specified, results will be filtered to include only those containing the specified album artist id.</param>
|
|
<param name="contributingArtistIds">Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.</param>
|
|
<param name="albums">Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.</param>
|
|
<param name="albumIds">Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.</param>
|
|
<param name="ids">Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.</param>
|
|
<param name="videoTypes">Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.</param>
|
|
<param name="minOfficialRating">Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).</param>
|
|
<param name="isLocked">Optional filter by items that are locked.</param>
|
|
<param name="isPlaceHolder">Optional filter by items that are placeholders.</param>
|
|
<param name="hasOfficialRating">Optional filter by items that have official ratings.</param>
|
|
<param name="collapseBoxSetItems">Whether or not to hide items behind their boxsets.</param>
|
|
<param name="minWidth">Optional. Filter by the minimum width of the item.</param>
|
|
<param name="minHeight">Optional. Filter by the minimum height of the item.</param>
|
|
<param name="maxWidth">Optional. Filter by the maximum width of the item.</param>
|
|
<param name="maxHeight">Optional. Filter by the maximum height of the item.</param>
|
|
<param name="is3D">Optional filter by items that are 3D, or not.</param>
|
|
<param name="seriesStatus">Optional filter by Series Status. Allows multiple, comma delimited.</param>
|
|
<param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a given input string.</param>
|
|
<param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</param>
|
|
<param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</param>
|
|
<param name="studioIds">Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.</param>
|
|
<param name="genreIds">Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.</param>
|
|
<param name="enableTotalRecordCount">Optional. Enable the total record count.</param>
|
|
<param name="enableImages">Optional, include image information in output.</param>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the items.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemsController.GetItemsByUserIdLegacy(System.Guid,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},MediaBrowser.Model.Entities.LocationType[],MediaBrowser.Model.Entities.LocationType[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Guid[],System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.String,Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],MediaBrowser.Model.Querying.ItemFilter[],System.Nullable{System.Boolean},Jellyfin.Data.Enums.MediaType[],MediaBrowser.Model.Entities.ImageType[],Jellyfin.Data.Enums.ItemSortBy[],System.Nullable{System.Boolean},System.String[],System.String[],System.String[],System.Int32[],System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.String,System.Guid[],System.String[],System.String[],System.String[],System.Guid[],System.Guid[],System.Guid[],System.Guid[],System.String[],System.Guid[],System.Guid[],MediaBrowser.Model.Entities.VideoType[],System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},MediaBrowser.Model.Entities.SeriesStatus[],System.String,System.String,System.String,System.Guid[],System.Guid[],System.Boolean,System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Gets items based on a query.
|
|
</summary>
|
|
<param name="userId">The user id supplied as query parameter.</param>
|
|
<param name="maxOfficialRating">Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).</param>
|
|
<param name="hasThemeSong">Optional filter by items with theme songs.</param>
|
|
<param name="hasThemeVideo">Optional filter by items with theme videos.</param>
|
|
<param name="hasSubtitles">Optional filter by items with subtitles.</param>
|
|
<param name="hasSpecialFeature">Optional filter by items with special features.</param>
|
|
<param name="hasTrailer">Optional filter by items with trailers.</param>
|
|
<param name="adjacentTo">Optional. Return items that are siblings of a supplied item.</param>
|
|
<param name="parentIndexNumber">Optional filter by parent index number.</param>
|
|
<param name="hasParentalRating">Optional filter by items that have or do not have a parental rating.</param>
|
|
<param name="isHd">Optional filter by items that are HD or not.</param>
|
|
<param name="is4K">Optional filter by items that are 4K or not.</param>
|
|
<param name="locationTypes">Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.</param>
|
|
<param name="excludeLocationTypes">Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.</param>
|
|
<param name="isMissing">Optional filter by items that are missing episodes or not.</param>
|
|
<param name="isUnaired">Optional filter by items that are unaired episodes or not.</param>
|
|
<param name="minCommunityRating">Optional filter by minimum community rating.</param>
|
|
<param name="minCriticRating">Optional filter by minimum critic rating.</param>
|
|
<param name="minPremiereDate">Optional. The minimum premiere date. Format = ISO.</param>
|
|
<param name="minDateLastSaved">Optional. The minimum last saved date. Format = ISO.</param>
|
|
<param name="minDateLastSavedForUser">Optional. The minimum last saved date for the current user. Format = ISO.</param>
|
|
<param name="maxPremiereDate">Optional. The maximum premiere date. Format = ISO.</param>
|
|
<param name="hasOverview">Optional filter by items that have an overview or not.</param>
|
|
<param name="hasImdbId">Optional filter by items that have an IMDb id or not.</param>
|
|
<param name="hasTmdbId">Optional filter by items that have a TMDb id or not.</param>
|
|
<param name="hasTvdbId">Optional filter by items that have a TVDb id or not.</param>
|
|
<param name="isMovie">Optional filter for live tv movies.</param>
|
|
<param name="isSeries">Optional filter for live tv series.</param>
|
|
<param name="isNews">Optional filter for live tv news.</param>
|
|
<param name="isKids">Optional filter for live tv kids.</param>
|
|
<param name="isSports">Optional filter for live tv sports.</param>
|
|
<param name="excludeItemIds">Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="recursive">When searching within folders, this determines whether or not the search will be recursive. true/false.</param>
|
|
<param name="searchTerm">Optional. Filter based on a search term.</param>
|
|
<param name="sortOrder">Sort Order - Ascending, Descending.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. 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.</param>
|
|
<param name="excludeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.</param>
|
|
<param name="filters">Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.</param>
|
|
<param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
|
|
<param name="mediaTypes">Optional filter by MediaType. Allows multiple, comma delimited.</param>
|
|
<param name="imageTypes">Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
|
<param name="isPlayed">Optional filter by items that are played, or not.</param>
|
|
<param name="genres">Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.</param>
|
|
<param name="officialRatings">Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.</param>
|
|
<param name="tags">Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.</param>
|
|
<param name="years">Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.</param>
|
|
<param name="enableUserData">Optional, include user data.</param>
|
|
<param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="person">Optional. If specified, results will be filtered to include only those containing the specified person.</param>
|
|
<param name="personIds">Optional. If specified, results will be filtered to include only those containing the specified person id.</param>
|
|
<param name="personTypes">Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.</param>
|
|
<param name="studios">Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.</param>
|
|
<param name="artists">Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.</param>
|
|
<param name="excludeArtistIds">Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.</param>
|
|
<param name="artistIds">Optional. If specified, results will be filtered to include only those containing the specified artist id.</param>
|
|
<param name="albumArtistIds">Optional. If specified, results will be filtered to include only those containing the specified album artist id.</param>
|
|
<param name="contributingArtistIds">Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.</param>
|
|
<param name="albums">Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.</param>
|
|
<param name="albumIds">Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.</param>
|
|
<param name="ids">Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.</param>
|
|
<param name="videoTypes">Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.</param>
|
|
<param name="minOfficialRating">Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).</param>
|
|
<param name="isLocked">Optional filter by items that are locked.</param>
|
|
<param name="isPlaceHolder">Optional filter by items that are placeholders.</param>
|
|
<param name="hasOfficialRating">Optional filter by items that have official ratings.</param>
|
|
<param name="collapseBoxSetItems">Whether or not to hide items behind their boxsets.</param>
|
|
<param name="minWidth">Optional. Filter by the minimum width of the item.</param>
|
|
<param name="minHeight">Optional. Filter by the minimum height of the item.</param>
|
|
<param name="maxWidth">Optional. Filter by the maximum width of the item.</param>
|
|
<param name="maxHeight">Optional. Filter by the maximum height of the item.</param>
|
|
<param name="is3D">Optional filter by items that are 3D, or not.</param>
|
|
<param name="seriesStatus">Optional filter by Series Status. Allows multiple, comma delimited.</param>
|
|
<param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a given input string.</param>
|
|
<param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</param>
|
|
<param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</param>
|
|
<param name="studioIds">Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.</param>
|
|
<param name="genreIds">Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.</param>
|
|
<param name="enableTotalRecordCount">Optional. Enable the total record count.</param>
|
|
<param name="enableImages">Optional, include image information in output.</param>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the items.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemsController.GetResumeItems(System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.MediaType[],System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],System.Boolean,System.Nullable{System.Boolean},System.Boolean)">
|
|
<summary>
|
|
Gets items based on a query.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="startIndex">The start index.</param>
|
|
<param name="limit">The item limit.</param>
|
|
<param name="searchTerm">The search term.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. 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.</param>
|
|
<param name="mediaTypes">Optional. Filter by MediaType. Allows multiple, comma delimited.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="excludeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.</param>
|
|
<param name="enableTotalRecordCount">Optional. Enable the total record count.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="excludeActiveSessions">Optional. Whether to exclude the currently active sessions.</param>
|
|
<response code="200">Items returned.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the items that are resumable.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemsController.GetResumeItemsLegacy(System.Guid,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.MediaType[],System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],System.Boolean,System.Nullable{System.Boolean},System.Boolean)">
|
|
<summary>
|
|
Gets items based on a query.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="startIndex">The start index.</param>
|
|
<param name="limit">The item limit.</param>
|
|
<param name="searchTerm">The search term.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. 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.</param>
|
|
<param name="mediaTypes">Optional. Filter by MediaType. Allows multiple, comma delimited.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="excludeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.</param>
|
|
<param name="enableTotalRecordCount">Optional. Enable the total record count.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="excludeActiveSessions">Optional. Whether to exclude the currently active sessions.</param>
|
|
<response code="200">Items returned.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the items that are resumable.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemsController.GetItemUserData(System.Nullable{System.Guid},System.Guid)">
|
|
<summary>
|
|
Get Item User Data.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="itemId">The item id.</param>
|
|
<response code="200">return item user data.</response>
|
|
<response code="404">Item is not found.</response>
|
|
<returns>Return <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemsController.GetItemUserDataLegacy(System.Guid,System.Guid)">
|
|
<summary>
|
|
Get Item User Data.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="itemId">The item id.</param>
|
|
<response code="200">return item user data.</response>
|
|
<response code="404">Item is not found.</response>
|
|
<returns>Return <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemsController.UpdateItemUserData(System.Nullable{System.Guid},System.Guid,MediaBrowser.Model.Dto.UpdateUserItemDataDto)">
|
|
<summary>
|
|
Update Item User Data.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userDataDto">New user data object.</param>
|
|
<response code="200">return updated user item data.</response>
|
|
<response code="404">Item is not found.</response>
|
|
<returns>Return <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemsController.UpdateItemUserDataLegacy(System.Guid,System.Guid,MediaBrowser.Model.Dto.UpdateUserItemDataDto)">
|
|
<summary>
|
|
Update Item User Data.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userDataDto">New user data object.</param>
|
|
<response code="200">return updated user item data.</response>
|
|
<response code="404">Item is not found.</response>
|
|
<returns>Return <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ItemUpdateController">
|
|
<summary>
|
|
Item update controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemUpdateController.#ctor(MediaBrowser.Model.IO.IFileSystem,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Providers.IProviderManager,MediaBrowser.Model.Globalization.ILocalizationManager,MediaBrowser.Controller.Configuration.IServerConfigurationManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ItemUpdateController"/> class.
|
|
</summary>
|
|
<param name="fileSystem">Instance of the <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="providerManager">Instance of the <see cref="T:MediaBrowser.Controller.Providers.IProviderManager"/> interface.</param>
|
|
<param name="localizationManager">Instance of the <see cref="T:MediaBrowser.Model.Globalization.ILocalizationManager"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemUpdateController.UpdateItem(System.Guid,MediaBrowser.Model.Dto.BaseItemDto)">
|
|
<summary>
|
|
Updates an item.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="request">The new item properties.</param>
|
|
<response code="204">Item updated.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the item could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemUpdateController.GetMetadataEditorInfo(System.Guid)">
|
|
<summary>
|
|
Gets metadata editor info for an item.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<response code="200">Item metadata editor returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> on success containing the metadata editor, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the item could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ItemUpdateController.UpdateItemContentType(System.Guid,System.String)">
|
|
<summary>
|
|
Updates an item's content type.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="contentType">The content type of the item.</param>
|
|
<response code="204">Item content type updated.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the item could not be found.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.LibraryController">
|
|
<summary>
|
|
Library Controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.#ctor(MediaBrowser.Controller.Providers.IProviderManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Model.Activity.IActivityManager,MediaBrowser.Model.Globalization.ILocalizationManager,MediaBrowser.Controller.Library.ILibraryMonitor,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.LibraryController},MediaBrowser.Controller.Configuration.IServerConfigurationManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.LibraryController"/> class.
|
|
</summary>
|
|
<param name="providerManager">Instance of the <see cref="T:MediaBrowser.Controller.Providers.IProviderManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="activityManager">Instance of the <see cref="T:MediaBrowser.Model.Activity.IActivityManager"/> interface.</param>
|
|
<param name="localization">Instance of the <see cref="T:MediaBrowser.Model.Globalization.ILocalizationManager"/> interface.</param>
|
|
<param name="libraryMonitor">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryMonitor"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetFile(System.Guid)">
|
|
<summary>
|
|
Get the original file of an item.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<response code="200">File stream returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> with the original file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetCriticReviews">
|
|
<summary>
|
|
Gets critic review for an item.
|
|
</summary>
|
|
<response code="200">Critic reviews returned.</response>
|
|
<returns>The list of critic reviews.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetThemeSongs(System.Guid,System.Nullable{System.Guid},System.Boolean,Jellyfin.Data.Enums.ItemSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[])">
|
|
<summary>
|
|
Get theme songs for an item.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="inheritFromParent">Optional. Determines whether or not parent items should be searched for theme media.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
|
<param name="sortOrder">Optional. Sort Order - Ascending, Descending.</param>
|
|
<response code="200">Theme songs returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>The item theme songs.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetThemeVideos(System.Guid,System.Nullable{System.Guid},System.Boolean,Jellyfin.Data.Enums.ItemSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[])">
|
|
<summary>
|
|
Get theme videos for an item.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="inheritFromParent">Optional. Determines whether or not parent items should be searched for theme media.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
|
<param name="sortOrder">Optional. Sort Order - Ascending, Descending.</param>
|
|
<response code="200">Theme videos returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>The item theme videos.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetThemeMedia(System.Guid,System.Nullable{System.Guid},System.Boolean,Jellyfin.Data.Enums.ItemSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[])">
|
|
<summary>
|
|
Get theme songs and videos for an item.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="inheritFromParent">Optional. Determines whether or not parent items should be searched for theme media.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
|
<param name="sortOrder">Optional. Sort Order - Ascending, Descending.</param>
|
|
<response code="200">Theme songs and videos returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>The item theme videos.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.RefreshLibrary">
|
|
<summary>
|
|
Starts a library scan.
|
|
</summary>
|
|
<response code="204">Library scan started.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.DeleteItem(System.Guid)">
|
|
<summary>
|
|
Deletes an item from the library and filesystem.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<response code="204">Item deleted.</response>
|
|
<response code="401">Unauthorized access.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.DeleteItems(System.Guid[])">
|
|
<summary>
|
|
Deletes items from the library and filesystem.
|
|
</summary>
|
|
<param name="ids">The item ids.</param>
|
|
<response code="204">Items deleted.</response>
|
|
<response code="401">Unauthorized access.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetItemCounts(System.Nullable{System.Guid},System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Get item counts.
|
|
</summary>
|
|
<param name="userId">Optional. Get counts from a specific user's library.</param>
|
|
<param name="isFavorite">Optional. Get counts of favorite items.</param>
|
|
<response code="200">Item counts returned.</response>
|
|
<returns>Item counts.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetAncestors(System.Guid,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets all parents of an item.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<response code="200">Item parents returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>Item parents.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetPhysicalPaths">
|
|
<summary>
|
|
Gets a list of physical paths from virtual folders.
|
|
</summary>
|
|
<response code="200">Physical paths returned.</response>
|
|
<returns>List of physical paths.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetMediaFolders(System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Gets all user media folders.
|
|
</summary>
|
|
<param name="isHidden">Optional. Filter by folders that are marked hidden, or not.</param>
|
|
<response code="200">Media folders returned.</response>
|
|
<returns>List of user media folders.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.PostUpdatedSeries(System.String)">
|
|
<summary>
|
|
Reports that new episodes of a series have been added by an external source.
|
|
</summary>
|
|
<param name="tvdbId">The tvdbId.</param>
|
|
<response code="204">Report success.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.PostUpdatedMovies(System.String,System.String)">
|
|
<summary>
|
|
Reports that new movies have been added by an external source.
|
|
</summary>
|
|
<param name="tmdbId">The tmdbId.</param>
|
|
<param name="imdbId">The imdbId.</param>
|
|
<response code="204">Report success.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.PostUpdatedMedia(Jellyfin.Api.Models.LibraryDtos.MediaUpdateInfoDto)">
|
|
<summary>
|
|
Reports that new movies have been added by an external source.
|
|
</summary>
|
|
<param name="dto">The update paths.</param>
|
|
<response code="204">Report success.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetDownload(System.Guid)">
|
|
<summary>
|
|
Downloads item media.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<response code="200">Media downloaded.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the media stream.</returns>
|
|
<exception cref="T:System.ArgumentException">User can't download or item can't be downloaded.</exception>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetSimilarItems(System.Guid,System.Guid[],System.Nullable{System.Guid},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[])">
|
|
<summary>
|
|
Gets similar items.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="excludeArtistIds">Exclude artist ids.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. 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, TrailerUrls.</param>
|
|
<response code="200">Similar items returned.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> containing the similar items.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryController.GetLibraryOptionsInfo(System.Nullable{Jellyfin.Data.Enums.CollectionType},System.Boolean)">
|
|
<summary>
|
|
Gets the library options info.
|
|
</summary>
|
|
<param name="libraryContentType">Library content type.</param>
|
|
<param name="isNewLibrary">Whether this is a new library.</param>
|
|
<response code="200">Library options info returned.</response>
|
|
<returns>Library options info.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.LibraryStructureController">
|
|
<summary>
|
|
The library structure controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryStructureController.#ctor(MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.ILibraryMonitor)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.LibraryStructureController"/> class.
|
|
</summary>
|
|
<param name="serverConfigurationManager">Instance of <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="libraryMonitor">Instance of <see cref="T:MediaBrowser.Controller.Library.ILibraryMonitor"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryStructureController.GetVirtualFolders">
|
|
<summary>
|
|
Gets all virtual folders.
|
|
</summary>
|
|
<response code="200">Virtual folders retrieved.</response>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with the virtual folders.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryStructureController.AddVirtualFolder(System.String,System.Nullable{MediaBrowser.Model.Entities.CollectionTypeOptions},System.String[],Jellyfin.Api.Models.LibraryStructureDto.AddVirtualFolderDto,System.Boolean)">
|
|
<summary>
|
|
Adds a virtual folder.
|
|
</summary>
|
|
<param name="name">The name of the virtual folder.</param>
|
|
<param name="collectionType">The type of the collection.</param>
|
|
<param name="paths">The paths of the virtual folder.</param>
|
|
<param name="libraryOptionsDto">The library options.</param>
|
|
<param name="refreshLibrary">Whether to refresh the library.</param>
|
|
<response code="204">Folder added.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryStructureController.RemoveVirtualFolder(System.String,System.Boolean)">
|
|
<summary>
|
|
Removes a virtual folder.
|
|
</summary>
|
|
<param name="name">The name of the folder.</param>
|
|
<param name="refreshLibrary">Whether to refresh the library.</param>
|
|
<response code="204">Folder removed.</response>
|
|
<response code="404">Folder not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryStructureController.RenameVirtualFolder(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Renames a virtual folder.
|
|
</summary>
|
|
<param name="name">The name of the virtual folder.</param>
|
|
<param name="newName">The new name.</param>
|
|
<param name="refreshLibrary">Whether to refresh the library.</param>
|
|
<response code="204">Folder renamed.</response>
|
|
<response code="404">Library doesn't exist.</response>
|
|
<response code="409">Library already exists.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the library doesn't exist, a <see cref="T:Microsoft.AspNetCore.Mvc.ConflictResult"/> if the new name is already taken.</returns>
|
|
<exception cref="T:System.ArgumentNullException">The new name may not be null.</exception>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryStructureController.AddMediaPath(Jellyfin.Api.Models.LibraryStructureDto.MediaPathDto,System.Boolean)">
|
|
<summary>
|
|
Add a media path to a library.
|
|
</summary>
|
|
<param name="mediaPathDto">The media path dto.</param>
|
|
<param name="refreshLibrary">Whether to refresh the library.</param>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
<response code="204">Media path added.</response>
|
|
<exception cref="T:System.ArgumentNullException">The name of the library may not be empty.</exception>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryStructureController.UpdateMediaPath(Jellyfin.Api.Models.LibraryStructureDto.UpdateMediaPathRequestDto)">
|
|
<summary>
|
|
Updates a media path.
|
|
</summary>
|
|
<param name="mediaPathRequestDto">The name of the library and path infos.</param>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
<response code="204">Media path updated.</response>
|
|
<exception cref="T:System.ArgumentNullException">The name of the library may not be empty.</exception>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryStructureController.RemoveMediaPath(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Remove a media path.
|
|
</summary>
|
|
<param name="name">The name of the library.</param>
|
|
<param name="path">The path to remove.</param>
|
|
<param name="refreshLibrary">Whether to refresh the library.</param>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
<response code="204">Media path removed.</response>
|
|
<exception cref="T:System.ArgumentException">The name of the library and path may not be empty.</exception>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LibraryStructureController.UpdateLibraryOptions(Jellyfin.Api.Models.LibraryStructureDto.UpdateLibraryOptionsDto)">
|
|
<summary>
|
|
Update library options.
|
|
</summary>
|
|
<param name="request">The library name and options.</param>
|
|
<response code="204">Library updated.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.LiveTvController">
|
|
<summary>
|
|
Live tv controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.#ctor(MediaBrowser.Controller.LiveTv.ILiveTvManager,MediaBrowser.Controller.LiveTv.IGuideManager,MediaBrowser.Controller.LiveTv.ITunerHostManager,MediaBrowser.Controller.LiveTv.IListingsManager,MediaBrowser.Controller.LiveTv.IRecordingsManager,MediaBrowser.Controller.Library.IUserManager,System.Net.Http.IHttpClientFactory,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Library.IMediaSourceManager,MediaBrowser.Common.Configuration.IConfigurationManager,MediaBrowser.Controller.MediaEncoding.ITranscodeManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.LiveTvController"/> class.
|
|
</summary>
|
|
<param name="liveTvManager">Instance of the <see cref="T:MediaBrowser.Controller.LiveTv.ILiveTvManager"/> interface.</param>
|
|
<param name="guideManager">Instance of the <see cref="T:MediaBrowser.Controller.LiveTv.IGuideManager"/> interface.</param>
|
|
<param name="tunerHostManager">Instance of the <see cref="T:MediaBrowser.Controller.LiveTv.ITunerHostManager"/> interface.</param>
|
|
<param name="listingsManager">Instance of the <see cref="T:MediaBrowser.Controller.LiveTv.IListingsManager"/> interface.</param>
|
|
<param name="recordingsManager">Instance of the <see cref="T:MediaBrowser.Controller.LiveTv.IRecordingsManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="httpClientFactory">Instance of the <see cref="T:System.Net.Http.IHttpClientFactory"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="mediaSourceManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IMediaSourceManager"/> interface.</param>
|
|
<param name="configurationManager">Instance of the <see cref="T:MediaBrowser.Common.Configuration.IConfigurationManager"/> interface.</param>
|
|
<param name="transcodeManager">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.ITranscodeManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetLiveTvInfo">
|
|
<summary>
|
|
Gets available live tv services.
|
|
</summary>
|
|
<response code="200">Available live tv services returned.</response>
|
|
<returns>
|
|
An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the available live tv services.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetLiveTvChannels(System.Nullable{MediaBrowser.Model.LiveTv.ChannelType},System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},Jellyfin.Data.Enums.ItemSortBy[],System.Nullable{Jellyfin.Database.Implementations.Enums.SortOrder},System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Gets available live tv channels.
|
|
</summary>
|
|
<param name="type">Optional. Filter by channel type.</param>
|
|
<param name="userId">Optional. Filter by user and attach user data.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="isMovie">Optional. Filter for movies.</param>
|
|
<param name="isSeries">Optional. Filter for series.</param>
|
|
<param name="isNews">Optional. Filter for news.</param>
|
|
<param name="isKids">Optional. Filter for kids.</param>
|
|
<param name="isSports">Optional. Filter for sports.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="isFavorite">Optional. Filter by channels that are favorites, or not.</param>
|
|
<param name="isLiked">Optional. Filter by channels that are liked, or not.</param>
|
|
<param name="isDisliked">Optional. Filter by channels that are disliked, or not.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">"Optional. The image types to include in the output.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="sortBy">Optional. Key to sort by.</param>
|
|
<param name="sortOrder">Optional. Sort order.</param>
|
|
<param name="enableFavoriteSorting">Optional. Incorporate favorite and like status into channel sorting.</param>
|
|
<param name="addCurrentProgram">Optional. Adds current program info to each channel.</param>
|
|
<response code="200">Available live tv channels returned.</response>
|
|
<returns>
|
|
An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the resulting available live tv channels.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetChannel(System.Guid,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets a live tv channel.
|
|
</summary>
|
|
<param name="channelId">Channel id.</param>
|
|
<param name="userId">Optional. Attach user data.</param>
|
|
<response code="200">Live tv channel returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the live tv channel.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetRecordings(System.String,System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.LiveTv.RecordingStatus},System.Nullable{System.Boolean},System.String,System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Boolean)">
|
|
<summary>
|
|
Gets live tv recordings.
|
|
</summary>
|
|
<param name="channelId">Optional. Filter by channel id.</param>
|
|
<param name="userId">Optional. Filter by user and attach user data.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="status">Optional. Filter by recording status.</param>
|
|
<param name="isInProgress">Optional. Filter by recordings that are in progress, or not.</param>
|
|
<param name="seriesTimerId">Optional. Filter by recordings belonging to a series timer.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="isMovie">Optional. Filter for movies.</param>
|
|
<param name="isSeries">Optional. Filter for series.</param>
|
|
<param name="isKids">Optional. Filter for kids.</param>
|
|
<param name="isSports">Optional. Filter for sports.</param>
|
|
<param name="isNews">Optional. Filter for news.</param>
|
|
<param name="isLibraryItem">Optional. Filter for is library item.</param>
|
|
<param name="enableTotalRecordCount">Optional. Return total record count.</param>
|
|
<response code="200">Live tv recordings returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the live tv recordings.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetRecordingsSeries(System.String,System.Nullable{System.Guid},System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.LiveTv.RecordingStatus},System.Nullable{System.Boolean},System.String,System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Boolean)">
|
|
<summary>
|
|
Gets live tv recording series.
|
|
</summary>
|
|
<param name="channelId">Optional. Filter by channel id.</param>
|
|
<param name="userId">Optional. Filter by user and attach user data.</param>
|
|
<param name="groupId">Optional. Filter by recording group.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="status">Optional. Filter by recording status.</param>
|
|
<param name="isInProgress">Optional. Filter by recordings that are in progress, or not.</param>
|
|
<param name="seriesTimerId">Optional. Filter by recordings belonging to a series timer.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="enableTotalRecordCount">Optional. Return total record count.</param>
|
|
<response code="200">Live tv recordings returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the live tv recordings.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetRecordingGroups(System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets live tv recording groups.
|
|
</summary>
|
|
<param name="userId">Optional. Filter by user and attach user data.</param>
|
|
<response code="200">Recording groups returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the recording groups.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetRecordingFolders(System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets recording folders.
|
|
</summary>
|
|
<param name="userId">Optional. Filter by user and attach user data.</param>
|
|
<response code="200">Recording folders returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the recording folders.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetRecording(System.Guid,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets a live tv recording.
|
|
</summary>
|
|
<param name="recordingId">Recording id.</param>
|
|
<param name="userId">Optional. Attach user data.</param>
|
|
<response code="200">Recording returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the live tv recording.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.ResetTuner(System.String)">
|
|
<summary>
|
|
Resets a tv tuner.
|
|
</summary>
|
|
<param name="tunerId">Tuner id.</param>
|
|
<response code="204">Tuner reset.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetTimer(System.String)">
|
|
<summary>
|
|
Gets a timer.
|
|
</summary>
|
|
<param name="timerId">Timer id.</param>
|
|
<response code="200">Timer returned.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task"/> containing an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> which contains the timer.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetDefaultTimer(System.String)">
|
|
<summary>
|
|
Gets the default values for a new timer.
|
|
</summary>
|
|
<param name="programId">Optional. To attach default values based on a program.</param>
|
|
<response code="200">Default values returned.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task"/> containing an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> which contains the default values for a timer.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetTimers(System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Gets the live tv timers.
|
|
</summary>
|
|
<param name="channelId">Optional. Filter by channel id.</param>
|
|
<param name="seriesTimerId">Optional. Filter by timers belonging to a series timer.</param>
|
|
<param name="isActive">Optional. Filter by timers that are active.</param>
|
|
<param name="isScheduled">Optional. Filter by timers that are scheduled.</param>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task"/> containing an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> which contains the live tv timers.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetLiveTvPrograms(System.Guid[],System.Nullable{System.Guid},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},Jellyfin.Data.Enums.ItemSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[],System.String[],System.Guid[],System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Nullable{System.Boolean},System.String,System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],System.Boolean)">
|
|
<summary>
|
|
Gets available live tv epgs.
|
|
</summary>
|
|
<param name="channelIds">The channels to return guide information for.</param>
|
|
<param name="userId">Optional. Filter by user id.</param>
|
|
<param name="minStartDate">Optional. The minimum premiere start date.</param>
|
|
<param name="hasAired">Optional. Filter by programs that have completed airing, or not.</param>
|
|
<param name="isAiring">Optional. Filter by programs that are currently airing, or not.</param>
|
|
<param name="maxStartDate">Optional. The maximum premiere start date.</param>
|
|
<param name="minEndDate">Optional. The minimum premiere end date.</param>
|
|
<param name="maxEndDate">Optional. The maximum premiere end date.</param>
|
|
<param name="isMovie">Optional. Filter for movies.</param>
|
|
<param name="isSeries">Optional. Filter for series.</param>
|
|
<param name="isNews">Optional. Filter for news.</param>
|
|
<param name="isKids">Optional. Filter for kids.</param>
|
|
<param name="isSports">Optional. Filter for sports.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.</param>
|
|
<param name="sortOrder">Sort Order - Ascending,Descending.</param>
|
|
<param name="genres">The genres to return guide information for.</param>
|
|
<param name="genreIds">The genre ids to return guide information for.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="seriesTimerId">Optional. Filter by series timer id.</param>
|
|
<param name="librarySeriesId">Optional. Filter by library series id.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableTotalRecordCount">Retrieve total record count.</param>
|
|
<response code="200">Live tv epgs returned.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task"/> containing a <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> which contains the live tv epgs.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetPrograms(Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto)">
|
|
<summary>
|
|
Gets available live tv epgs.
|
|
</summary>
|
|
<param name="body">Request body.</param>
|
|
<response code="200">Live tv epgs returned.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task"/> containing a <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> which contains the live tv epgs.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetRecommendedPrograms(System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Guid[],MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Boolean)">
|
|
<summary>
|
|
Gets recommended live tv epgs.
|
|
</summary>
|
|
<param name="userId">Optional. filter by user id.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="isAiring">Optional. Filter by programs that are currently airing, or not.</param>
|
|
<param name="hasAired">Optional. Filter by programs that have completed airing, or not.</param>
|
|
<param name="isSeries">Optional. Filter for series.</param>
|
|
<param name="isMovie">Optional. Filter for movies.</param>
|
|
<param name="isNews">Optional. Filter for news.</param>
|
|
<param name="isKids">Optional. Filter for kids.</param>
|
|
<param name="isSports">Optional. Filter for sports.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="genreIds">The genres to return guide information for.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableUserData">Optional. include user data.</param>
|
|
<param name="enableTotalRecordCount">Retrieve total record count.</param>
|
|
<response code="200">Recommended epgs returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the queryresult of recommended epgs.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetProgram(System.String,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets a live tv program.
|
|
</summary>
|
|
<param name="programId">Program id.</param>
|
|
<param name="userId">Optional. Attach user data.</param>
|
|
<response code="200">Program returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the livetv program.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.DeleteRecording(System.Guid)">
|
|
<summary>
|
|
Deletes a live tv recording.
|
|
</summary>
|
|
<param name="recordingId">Recording id.</param>
|
|
<response code="204">Recording deleted.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.CancelTimer(System.String)">
|
|
<summary>
|
|
Cancels a live tv timer.
|
|
</summary>
|
|
<param name="timerId">Timer id.</param>
|
|
<response code="204">Timer deleted.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.UpdateTimer(System.String,MediaBrowser.Model.LiveTv.TimerInfoDto)">
|
|
<summary>
|
|
Updates a live tv timer.
|
|
</summary>
|
|
<param name="timerId">Timer id.</param>
|
|
<param name="timerInfo">New timer info.</param>
|
|
<response code="204">Timer updated.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.CreateTimer(MediaBrowser.Model.LiveTv.TimerInfoDto)">
|
|
<summary>
|
|
Creates a live tv timer.
|
|
</summary>
|
|
<param name="timerInfo">New timer info.</param>
|
|
<response code="204">Timer created.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetSeriesTimer(System.String)">
|
|
<summary>
|
|
Gets a live tv series timer.
|
|
</summary>
|
|
<param name="timerId">Timer id.</param>
|
|
<response code="200">Series timer returned.</response>
|
|
<response code="404">Series timer not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if timer not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetSeriesTimers(System.String,System.Nullable{Jellyfin.Database.Implementations.Enums.SortOrder})">
|
|
<summary>
|
|
Gets live tv series timers.
|
|
</summary>
|
|
<param name="sortBy">Optional. Sort by SortName or Priority.</param>
|
|
<param name="sortOrder">Optional. Sort in Ascending or Descending order.</param>
|
|
<response code="200">Timers returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> of live tv series timers.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.CancelSeriesTimer(System.String)">
|
|
<summary>
|
|
Cancels a live tv series timer.
|
|
</summary>
|
|
<param name="timerId">Timer id.</param>
|
|
<response code="204">Timer cancelled.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.UpdateSeriesTimer(System.String,MediaBrowser.Model.LiveTv.SeriesTimerInfoDto)">
|
|
<summary>
|
|
Updates a live tv series timer.
|
|
</summary>
|
|
<param name="timerId">Timer id.</param>
|
|
<param name="seriesTimerInfo">New series timer info.</param>
|
|
<response code="204">Series timer updated.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.CreateSeriesTimer(MediaBrowser.Model.LiveTv.SeriesTimerInfoDto)">
|
|
<summary>
|
|
Creates a live tv series timer.
|
|
</summary>
|
|
<param name="seriesTimerInfo">New series timer info.</param>
|
|
<response code="204">Series timer info created.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetRecordingGroup(System.Guid)">
|
|
<summary>
|
|
Get recording group.
|
|
</summary>
|
|
<param name="groupId">Group id.</param>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetGuideInfo">
|
|
<summary>
|
|
Get guide info.
|
|
</summary>
|
|
<response code="200">Guide info returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the guide info.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.AddTunerHost(MediaBrowser.Model.LiveTv.TunerHostInfo)">
|
|
<summary>
|
|
Adds a tuner host.
|
|
</summary>
|
|
<param name="tunerHostInfo">New tuner host.</param>
|
|
<response code="200">Created tuner host returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the created tuner host.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.DeleteTunerHost(System.String)">
|
|
<summary>
|
|
Deletes a tuner host.
|
|
</summary>
|
|
<param name="id">Tuner host id.</param>
|
|
<response code="204">Tuner host deleted.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetDefaultListingProvider">
|
|
<summary>
|
|
Gets default listings provider info.
|
|
</summary>
|
|
<response code="200">Default listings provider info returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the default listings provider info.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.AddListingProvider(System.String,MediaBrowser.Model.LiveTv.ListingsProviderInfo,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Adds a listings provider.
|
|
</summary>
|
|
<param name="pw">Password.</param>
|
|
<param name="listingsProviderInfo">New listings info.</param>
|
|
<param name="validateListings">Validate listings.</param>
|
|
<param name="validateLogin">Validate login.</param>
|
|
<response code="200">Created listings provider returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the created listings provider.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.DeleteListingProvider(System.String)">
|
|
<summary>
|
|
Delete listing provider.
|
|
</summary>
|
|
<param name="id">Listing provider id.</param>
|
|
<response code="204">Listing provider deleted.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetLineups(System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
Gets available lineups.
|
|
</summary>
|
|
<param name="id">Provider id.</param>
|
|
<param name="type">Provider type.</param>
|
|
<param name="location">Location.</param>
|
|
<param name="country">Country.</param>
|
|
<response code="200">Available lineups returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the available lineups.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetSchedulesDirectCountries">
|
|
<summary>
|
|
Gets available countries.
|
|
</summary>
|
|
<response code="200">Available countries returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the available countries.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetChannelMappingOptions(System.String)">
|
|
<summary>
|
|
Get channel mapping options.
|
|
</summary>
|
|
<param name="providerId">Provider id.</param>
|
|
<response code="200">Channel mapping options returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the channel mapping options.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.SetChannelMapping(Jellyfin.Api.Models.LiveTvDtos.SetChannelMappingDto)">
|
|
<summary>
|
|
Set channel mappings.
|
|
</summary>
|
|
<param name="dto">The set channel mapping dto.</param>
|
|
<response code="200">Created channel mapping returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the created channel mapping.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetTunerHostTypes">
|
|
<summary>
|
|
Get tuner host types.
|
|
</summary>
|
|
<response code="200">Tuner host types returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the tuner host types.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.DiscoverTuners(System.Boolean)">
|
|
<summary>
|
|
Discover tuners.
|
|
</summary>
|
|
<param name="newDevicesOnly">Only discover new tuners.</param>
|
|
<response code="200">Tuners returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the tuners.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetLiveRecordingFile(System.String)">
|
|
<summary>
|
|
Gets a live tv recording stream.
|
|
</summary>
|
|
<param name="recordingId">Recording id.</param>
|
|
<response code="200">Recording stream returned.</response>
|
|
<response code="404">Recording not found.</response>
|
|
<returns>
|
|
An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the recording stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if recording not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LiveTvController.GetLiveStreamFile(System.String,System.String)">
|
|
<summary>
|
|
Gets a live tv channel stream.
|
|
</summary>
|
|
<param name="streamId">Stream id.</param>
|
|
<param name="container">Container type.</param>
|
|
<response code="200">Stream returned.</response>
|
|
<response code="404">Stream not found.</response>
|
|
<returns>
|
|
An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the channel stream on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if stream not found.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.LocalizationController">
|
|
<summary>
|
|
Localization controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LocalizationController.#ctor(MediaBrowser.Model.Globalization.ILocalizationManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.LocalizationController"/> class.
|
|
</summary>
|
|
<param name="localization">Instance of the <see cref="T:MediaBrowser.Model.Globalization.ILocalizationManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LocalizationController.GetCultures">
|
|
<summary>
|
|
Gets known cultures.
|
|
</summary>
|
|
<response code="200">Known cultures returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of cultures.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LocalizationController.GetCountries">
|
|
<summary>
|
|
Gets known countries.
|
|
</summary>
|
|
<response code="200">Known countries returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of countries.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LocalizationController.GetParentalRatings">
|
|
<summary>
|
|
Gets known parental ratings.
|
|
</summary>
|
|
<response code="200">Known parental ratings returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of parental ratings.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LocalizationController.GetLocalizationOptions">
|
|
<summary>
|
|
Gets localization options.
|
|
</summary>
|
|
<response code="200">Localization options returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of localization options.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.LyricsController">
|
|
<summary>
|
|
Lyrics controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LyricsController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Lyrics.ILyricManager,MediaBrowser.Controller.Providers.IProviderManager,MediaBrowser.Model.IO.IFileSystem,MediaBrowser.Controller.Library.IUserManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.LyricsController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="lyricManager">Instance of the <see cref="T:MediaBrowser.Controller.Lyrics.ILyricManager"/> interface.</param>
|
|
<param name="providerManager">Instance of the <see cref="T:MediaBrowser.Controller.Providers.IProviderManager"/> interface.</param>
|
|
<param name="fileSystem">Instance of the <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LyricsController.GetLyrics(System.Guid)">
|
|
<summary>
|
|
Gets an item's lyrics.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Lyrics returned.</response>
|
|
<response code="404">Something went wrong. No Lyrics will be returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the item's lyrics.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LyricsController.UploadLyrics(System.Guid,System.String)">
|
|
<summary>
|
|
Upload an external lyric file.
|
|
</summary>
|
|
<param name="itemId">The item the lyric belongs to.</param>
|
|
<param name="fileName">Name of the file being uploaded.</param>
|
|
<response code="200">Lyrics uploaded.</response>
|
|
<response code="400">Error processing upload.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>The uploaded lyric.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LyricsController.DeleteLyrics(System.Guid)">
|
|
<summary>
|
|
Deletes an external lyric file.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<response code="204">Lyric deleted.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LyricsController.SearchRemoteLyrics(System.Guid)">
|
|
<summary>
|
|
Search remote lyrics.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<response code="200">Lyrics retrieved.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>An array of <see cref="T:MediaBrowser.Model.Providers.RemoteLyricInfo"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LyricsController.DownloadRemoteLyrics(System.Guid,System.String)">
|
|
<summary>
|
|
Downloads a remote lyric.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="lyricId">The lyric id.</param>
|
|
<response code="200">Lyric downloaded.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.LyricsController.GetRemoteLyrics(System.String)">
|
|
<summary>
|
|
Gets the remote lyrics.
|
|
</summary>
|
|
<param name="lyricId">The remote provider item id.</param>
|
|
<response code="200">File returned.</response>
|
|
<response code="404">Lyric not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> with the lyric file.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.MediaInfoController">
|
|
<summary>
|
|
The media info controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MediaInfoController.#ctor(MediaBrowser.Controller.Library.IMediaSourceManager,MediaBrowser.Controller.Devices.IDeviceManager,MediaBrowser.Controller.Library.ILibraryManager,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.MediaInfoController},Jellyfin.Api.Helpers.MediaInfoHelper,MediaBrowser.Controller.Library.IUserManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.MediaInfoController"/> class.
|
|
</summary>
|
|
<param name="mediaSourceManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IMediaSourceManager"/> interface.</param>
|
|
<param name="deviceManager">Instance of the <see cref="T:MediaBrowser.Controller.Devices.IDeviceManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="mediaInfoHelper">Instance of the <see cref="T:Jellyfin.Api.Helpers.MediaInfoHelper"/>.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface..</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MediaInfoController.GetPlaybackInfo(System.Guid,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets live playback media info for an item.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">The user id.</param>
|
|
<response code="200">Playback info returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing a <see cref="T:MediaBrowser.Model.MediaInfo.PlaybackInfoResponse"/> with the playback information.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MediaInfoController.GetPostedPlaybackInfo(System.Guid,System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto)">
|
|
<summary>
|
|
Gets live playback media info for an item.
|
|
</summary>
|
|
<remarks>
|
|
For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.
|
|
Query parameters are obsolete.
|
|
</remarks>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">The user id.</param>
|
|
<param name="maxStreamingBitrate">The maximum streaming bitrate.</param>
|
|
<param name="startTimeTicks">The start time in ticks.</param>
|
|
<param name="audioStreamIndex">The audio stream index.</param>
|
|
<param name="subtitleStreamIndex">The subtitle stream index.</param>
|
|
<param name="maxAudioChannels">The maximum number of audio channels.</param>
|
|
<param name="mediaSourceId">The media source id.</param>
|
|
<param name="liveStreamId">The livestream id.</param>
|
|
<param name="autoOpenLiveStream">Whether to auto open the livestream.</param>
|
|
<param name="enableDirectPlay">Whether to enable direct play. Default: true.</param>
|
|
<param name="enableDirectStream">Whether to enable direct stream. Default: true.</param>
|
|
<param name="enableTranscoding">Whether to enable transcoding. Default: true.</param>
|
|
<param name="allowVideoStreamCopy">Whether to allow to copy the video stream. Default: true.</param>
|
|
<param name="allowAudioStreamCopy">Whether to allow to copy the audio stream. Default: true.</param>
|
|
<param name="playbackInfoDto">The playback info.</param>
|
|
<response code="200">Playback info returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing a <see cref="T:MediaBrowser.Model.MediaInfo.PlaybackInfoResponse"/> with the playback info.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MediaInfoController.OpenLiveStream(System.String,System.Nullable{System.Guid},System.String,System.Nullable{System.Int32},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Guid},Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Opens a media source.
|
|
</summary>
|
|
<param name="openToken">The open token.</param>
|
|
<param name="userId">The user id.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="maxStreamingBitrate">The maximum streaming bitrate.</param>
|
|
<param name="startTimeTicks">The start time in ticks.</param>
|
|
<param name="audioStreamIndex">The audio stream index.</param>
|
|
<param name="subtitleStreamIndex">The subtitle stream index.</param>
|
|
<param name="maxAudioChannels">The maximum number of audio channels.</param>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="openLiveStreamDto">The open live stream dto.</param>
|
|
<param name="enableDirectPlay">Whether to enable direct play. Default: true.</param>
|
|
<param name="enableDirectStream">Whether to enable direct stream. Default: true.</param>
|
|
<param name="alwaysBurnInSubtitleWhenTranscoding">Always burn-in subtitle when transcoding.</param>
|
|
<response code="200">Media source opened.</response>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing a <see cref="T:MediaBrowser.Model.MediaInfo.LiveStreamResponse"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MediaInfoController.CloseLiveStream(System.String)">
|
|
<summary>
|
|
Closes a media source.
|
|
</summary>
|
|
<param name="liveStreamId">The livestream id.</param>
|
|
<response code="204">Livestream closed.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MediaInfoController.GetBitrateTestBytes(System.Int32)">
|
|
<summary>
|
|
Tests the network with a request with the size of the bitrate.
|
|
</summary>
|
|
<param name="size">The bitrate. Defaults to 102400.</param>
|
|
<response code="200">Test buffer returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> with specified bitrate.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.MediaSegmentsController">
|
|
<summary>
|
|
Media Segments api.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MediaSegmentsController.#ctor(MediaBrowser.Controller.MediaSegments.IMediaSegmentManager,MediaBrowser.Controller.Library.ILibraryManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.MediaSegmentsController"/> class.
|
|
</summary>
|
|
<param name="mediaSegmentManager">MediaSegments Manager.</param>
|
|
<param name="libraryManager">The Library manager.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MediaSegmentsController.GetItemSegments(System.Guid,System.Collections.Generic.IEnumerable{Jellyfin.Database.Implementations.Enums.MediaSegmentType})">
|
|
<summary>
|
|
Gets all media segments based on an itemId.
|
|
</summary>
|
|
<param name="itemId">The ItemId.</param>
|
|
<param name="includeSegmentTypes">Optional filter of requested segment types.</param>
|
|
<returns>A list of media segment objects related to the requested itemId.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.MoviesController">
|
|
<summary>
|
|
Movies controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MoviesController.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Configuration.IServerConfigurationManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.MoviesController"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MoviesController.GetMovieRecommendations(System.Nullable{System.Guid},System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],System.Int32,System.Int32)">
|
|
<summary>
|
|
Gets movie recommendations.
|
|
</summary>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. The fields to return.</param>
|
|
<param name="categoryLimit">The max number of categories to return.</param>
|
|
<param name="itemLimit">The max number of items to return per category.</param>
|
|
<response code="200">Movie recommendations returned.</response>
|
|
<returns>The list of movie recommendations.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.MusicGenresController">
|
|
<summary>
|
|
The music genres controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MusicGenresController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Dto.IDtoService)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.MusicGenresController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="userManager">Instance of <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="dtoService">Instance of <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MusicGenresController.GetMusicGenres(System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Nullable{System.Guid},System.String,System.String,System.String,Jellyfin.Data.Enums.ItemSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable{System.Boolean},System.Boolean)">
|
|
<summary>
|
|
Gets all music genres from a given item, folder, or the entire library.
|
|
</summary>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="searchTerm">The search term.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="excludeItemTypes">Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
|
|
<param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="userId">User id.</param>
|
|
<param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a given input string.</param>
|
|
<param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</param>
|
|
<param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited.</param>
|
|
<param name="sortOrder">Sort Order - Ascending,Descending.</param>
|
|
<param name="enableImages">Optional, include image information in output.</param>
|
|
<param name="enableTotalRecordCount">Optional. Include total record count.</param>
|
|
<response code="200">Music genres returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the queryresult of music genres.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.MusicGenresController.GetMusicGenre(System.String,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets a music genre, by name.
|
|
</summary>
|
|
<param name="genreName">The genre name.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing a <see cref="T:MediaBrowser.Model.Dto.BaseItemDto"/> with the music genre.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.PackageController">
|
|
<summary>
|
|
Package Controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PackageController.#ctor(MediaBrowser.Common.Updates.IInstallationManager,MediaBrowser.Controller.Configuration.IServerConfigurationManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.PackageController"/> class.
|
|
</summary>
|
|
<param name="installationManager">Instance of the <see cref="T:MediaBrowser.Common.Updates.IInstallationManager"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PackageController.GetPackageInfo(System.String,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets a package by name or assembly GUID.
|
|
</summary>
|
|
<param name="name">The name of the package.</param>
|
|
<param name="assemblyGuid">The GUID of the associated assembly.</param>
|
|
<response code="200">Package retrieved.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Updates.PackageInfo"/> containing package information.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PackageController.GetPackages">
|
|
<summary>
|
|
Gets available packages.
|
|
</summary>
|
|
<response code="200">Available packages returned.</response>
|
|
<returns>An <see cref="T:MediaBrowser.Model.Updates.PackageInfo"/> containing available packages information.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PackageController.InstallPackage(System.String,System.Nullable{System.Guid},System.String,System.String)">
|
|
<summary>
|
|
Installs a package.
|
|
</summary>
|
|
<param name="name">Package name.</param>
|
|
<param name="assemblyGuid">GUID of the associated assembly.</param>
|
|
<param name="version">Optional version. Defaults to latest version.</param>
|
|
<param name="repositoryUrl">Optional. Specify the repository to install from.</param>
|
|
<response code="204">Package found.</response>
|
|
<response code="404">Package not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the package could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PackageController.CancelPackageInstallation(System.Guid)">
|
|
<summary>
|
|
Cancels a package installation.
|
|
</summary>
|
|
<param name="packageId">Installation Id.</param>
|
|
<response code="204">Installation cancelled.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on successfully cancelling a package installation.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PackageController.GetRepositories">
|
|
<summary>
|
|
Gets all package repositories.
|
|
</summary>
|
|
<response code="200">Package repositories returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the list of package repositories.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PackageController.SetRepositories(MediaBrowser.Model.Updates.RepositoryInfo[])">
|
|
<summary>
|
|
Sets the enabled and existing package repositories.
|
|
</summary>
|
|
<param name="repositoryInfos">The list of package repositories.</param>
|
|
<response code="204">Package repositories saved.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.PersonsController">
|
|
<summary>
|
|
Persons controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PersonsController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Library.IUserManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.PersonsController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PersonsController.GetPersons(System.Nullable{System.Int32},System.String,MediaBrowser.Model.Querying.ItemFields[],MediaBrowser.Model.Querying.ItemFilter[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.String[],System.String[],System.Nullable{System.Guid},System.Nullable{System.Guid},System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Gets all persons.
|
|
</summary>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="searchTerm">The search term.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="filters">Optional. Specify additional filters to apply.</param>
|
|
<param name="isFavorite">Optional filter by items that are marked as favorite, or not. userId is required.</param>
|
|
<param name="enableUserData">Optional, include user data.</param>
|
|
<param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="excludePersonTypes">Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited.</param>
|
|
<param name="personTypes">Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited.</param>
|
|
<param name="appearsInItemId">Optional. If specified, person results will be filtered on items related to said persons.</param>
|
|
<param name="userId">User id.</param>
|
|
<param name="enableImages">Optional, include image information in output.</param>
|
|
<response code="200">Persons returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the queryresult of persons.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PersonsController.GetPerson(System.String,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Get person by name.
|
|
</summary>
|
|
<param name="name">Person name.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<response code="200">Person returned.</response>
|
|
<response code="404">Person not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the person on success,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if person not found.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.PlaylistsController">
|
|
<summary>
|
|
Playlists controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.#ctor(MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Playlists.IPlaylistManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.PlaylistsController"/> class.
|
|
</summary>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="playlistManager">Instance of the <see cref="T:MediaBrowser.Controller.Playlists.IPlaylistManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.CreatePlaylist(System.String,System.Collections.Generic.IReadOnlyList{System.Guid},System.Nullable{System.Guid},System.Nullable{Jellyfin.Data.Enums.MediaType},Jellyfin.Api.Models.PlaylistDtos.CreatePlaylistDto)">
|
|
<summary>
|
|
Creates a new playlist.
|
|
</summary>
|
|
<remarks>
|
|
For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.
|
|
Query parameters are obsolete.
|
|
</remarks>
|
|
<param name="name">The playlist name.</param>
|
|
<param name="ids">The item ids.</param>
|
|
<param name="userId">The user id.</param>
|
|
<param name="mediaType">The media type.</param>
|
|
<param name="createPlaylistRequest">The create playlist payload.</param>
|
|
<response code="200">Playlist created.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to create a playlist.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> indicating success.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.UpdatePlaylist(System.Guid,Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto)">
|
|
<summary>
|
|
Updates a playlist.
|
|
</summary>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<param name="updatePlaylistRequest">The <see cref="T:Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto"/> id.</param>
|
|
<response code="204">Playlist updated.</response>
|
|
<response code="403">Access forbidden.</response>
|
|
<response code="404">Playlist not found.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to update a playlist.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> indicating success.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.GetPlaylist(System.Guid)">
|
|
<summary>
|
|
Get a playlist.
|
|
</summary>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<response code="200">The playlist.</response>
|
|
<response code="404">Playlist not found.</response>
|
|
<returns>
|
|
A <see cref="T:MediaBrowser.Controller.Playlists.Playlist"/> objects.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.GetPlaylistUsers(System.Guid)">
|
|
<summary>
|
|
Get a playlist's users.
|
|
</summary>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<response code="200">Found shares.</response>
|
|
<response code="403">Access forbidden.</response>
|
|
<response code="404">Playlist not found.</response>
|
|
<returns>
|
|
A list of <see cref="T:MediaBrowser.Model.Entities.PlaylistUserPermissions"/> objects.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.GetPlaylistUser(System.Guid,System.Guid)">
|
|
<summary>
|
|
Get a playlist user.
|
|
</summary>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<param name="userId">The user id.</param>
|
|
<response code="200">User permission found.</response>
|
|
<response code="403">Access forbidden.</response>
|
|
<response code="404">Playlist not found.</response>
|
|
<returns>
|
|
<see cref="T:MediaBrowser.Model.Entities.PlaylistUserPermissions"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.UpdatePlaylistUser(System.Guid,System.Guid,Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto)">
|
|
<summary>
|
|
Modify a user of a playlist's users.
|
|
</summary>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<param name="userId">The user id.</param>
|
|
<param name="updatePlaylistUserRequest">The <see cref="T:Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto"/>.</param>
|
|
<response code="204">User's permissions modified.</response>
|
|
<response code="403">Access forbidden.</response>
|
|
<response code="404">Playlist not found.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to modify an user's playlist permissions.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> indicating success.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.RemoveUserFromPlaylist(System.Guid,System.Guid)">
|
|
<summary>
|
|
Remove a user from a playlist's users.
|
|
</summary>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<param name="userId">The user id.</param>
|
|
<response code="204">User permissions removed from playlist.</response>
|
|
<response code="401">Unauthorized access.</response>
|
|
<response code="404">No playlist or user permissions found.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation to delete a user from a playlist's shares.
|
|
The task result contains an <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> indicating success.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.AddItemToPlaylist(System.Guid,System.Guid[],System.Nullable{System.Int32},System.Nullable{System.Guid})">
|
|
<summary>
|
|
Adds items to a playlist.
|
|
</summary>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<param name="ids">Item id, comma delimited.</param>
|
|
<param name="position">Optional. 0-based index where to place the items or at the end if <c>null</c>.</param>
|
|
<param name="userId">The userId.</param>
|
|
<response code="204">Items added to playlist.</response>
|
|
<response code="403">Access forbidden.</response>
|
|
<response code="404">Playlist not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.MoveItem(System.String,System.String,System.Int32)">
|
|
<summary>
|
|
Moves a playlist item.
|
|
</summary>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="newIndex">The new index.</param>
|
|
<response code="204">Item moved to new index.</response>
|
|
<response code="403">Access forbidden.</response>
|
|
<response code="404">Playlist not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.RemoveItemFromPlaylist(System.String,System.String[])">
|
|
<summary>
|
|
Removes items from a playlist.
|
|
</summary>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<param name="entryIds">The item ids, comma delimited.</param>
|
|
<response code="204">Items removed.</response>
|
|
<response code="403">Access forbidden.</response>
|
|
<response code="404">Playlist not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaylistsController.GetPlaylistItems(System.Guid,System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[])">
|
|
<summary>
|
|
Gets the original items of a playlist.
|
|
</summary>
|
|
<param name="playlistId">The playlist id.</param>
|
|
<param name="userId">User id.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<response code="200">Original playlist returned.</response>
|
|
<response code="404">Access forbidden.</response>
|
|
<response code="404">Playlist not found.</response>
|
|
<returns>The original playlist items.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.PlaystateController">
|
|
<summary>
|
|
Playstate controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.IUserDataManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Session.ISessionManager,Microsoft.Extensions.Logging.ILoggerFactory,MediaBrowser.Controller.MediaEncoding.ITranscodeManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.PlaystateController"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="userDataRepository">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserDataManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="sessionManager">Instance of the <see cref="T:MediaBrowser.Controller.Session.ISessionManager"/> interface.</param>
|
|
<param name="loggerFactory">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> interface.</param>
|
|
<param name="transcodeManager">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.ITranscodeManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.MarkPlayedItem(System.Nullable{System.Guid},System.Guid,System.Nullable{System.DateTime})">
|
|
<summary>
|
|
Marks an item as played for user.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="datePlayed">Optional. The date the item was played.</param>
|
|
<response code="200">Item marked as played.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item was not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.MarkPlayedItemLegacy(System.Guid,System.Guid,System.Nullable{System.DateTime})">
|
|
<summary>
|
|
Marks an item as played for user.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="datePlayed">Optional. The date the item was played.</param>
|
|
<response code="200">Item marked as played.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item was not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.MarkUnplayedItem(System.Nullable{System.Guid},System.Guid)">
|
|
<summary>
|
|
Marks an item as unplayed for user.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Item marked as unplayed.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item was not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.MarkUnplayedItemLegacy(System.Guid,System.Guid)">
|
|
<summary>
|
|
Marks an item as unplayed for user.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Item marked as unplayed.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if item was not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.ReportPlaybackStart(MediaBrowser.Model.Session.PlaybackStartInfo)">
|
|
<summary>
|
|
Reports playback has started within a session.
|
|
</summary>
|
|
<param name="playbackStartInfo">The playback start info.</param>
|
|
<response code="204">Playback start recorded.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.ReportPlaybackProgress(MediaBrowser.Model.Session.PlaybackProgressInfo)">
|
|
<summary>
|
|
Reports playback progress within a session.
|
|
</summary>
|
|
<param name="playbackProgressInfo">The playback progress info.</param>
|
|
<response code="204">Playback progress recorded.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.PingPlaybackSession(System.String)">
|
|
<summary>
|
|
Pings a playback session.
|
|
</summary>
|
|
<param name="playSessionId">Playback session id.</param>
|
|
<response code="204">Playback session pinged.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.ReportPlaybackStopped(MediaBrowser.Model.Session.PlaybackStopInfo)">
|
|
<summary>
|
|
Reports playback has stopped within a session.
|
|
</summary>
|
|
<param name="playbackStopInfo">The playback stop info.</param>
|
|
<response code="204">Playback stop recorded.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.OnPlaybackStart(System.Guid,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Session.PlayMethod},System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Reports that a session has begun playing an item.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="mediaSourceId">The id of the MediaSource.</param>
|
|
<param name="audioStreamIndex">The audio stream index.</param>
|
|
<param name="subtitleStreamIndex">The subtitle stream index.</param>
|
|
<param name="playMethod">The play method.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="canSeek">Indicates if the client can seek.</param>
|
|
<response code="204">Play start recorded.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.OnPlaybackStartLegacy(System.Guid,System.Guid,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Session.PlayMethod},System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Reports that a user has begun playing an item.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="mediaSourceId">The id of the MediaSource.</param>
|
|
<param name="audioStreamIndex">The audio stream index.</param>
|
|
<param name="subtitleStreamIndex">The subtitle stream index.</param>
|
|
<param name="playMethod">The play method.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="canSeek">Indicates if the client can seek.</param>
|
|
<response code="204">Play start recorded.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.OnPlaybackProgress(System.Guid,System.String,System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Session.PlayMethod},System.String,System.String,System.Nullable{MediaBrowser.Model.Session.RepeatMode},System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Reports a session's playback progress.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="mediaSourceId">The id of the MediaSource.</param>
|
|
<param name="positionTicks">Optional. The current position, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="audioStreamIndex">The audio stream index.</param>
|
|
<param name="subtitleStreamIndex">The subtitle stream index.</param>
|
|
<param name="volumeLevel">Scale of 0-100.</param>
|
|
<param name="playMethod">The play method.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="repeatMode">The repeat mode.</param>
|
|
<param name="isPaused">Indicates if the player is paused.</param>
|
|
<param name="isMuted">Indicates if the player is muted.</param>
|
|
<response code="204">Play progress recorded.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.OnPlaybackProgressLegacy(System.Guid,System.Guid,System.String,System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Session.PlayMethod},System.String,System.String,System.Nullable{MediaBrowser.Model.Session.RepeatMode},System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Reports a user's playback progress.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="mediaSourceId">The id of the MediaSource.</param>
|
|
<param name="positionTicks">Optional. The current position, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="audioStreamIndex">The audio stream index.</param>
|
|
<param name="subtitleStreamIndex">The subtitle stream index.</param>
|
|
<param name="volumeLevel">Scale of 0-100.</param>
|
|
<param name="playMethod">The play method.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="repeatMode">The repeat mode.</param>
|
|
<param name="isPaused">Indicates if the player is paused.</param>
|
|
<param name="isMuted">Indicates if the player is muted.</param>
|
|
<response code="204">Play progress recorded.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.OnPlaybackStopped(System.Guid,System.String,System.String,System.Nullable{System.Int64},System.String,System.String)">
|
|
<summary>
|
|
Reports that a session has stopped playing an item.
|
|
</summary>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="mediaSourceId">The id of the MediaSource.</param>
|
|
<param name="nextMediaType">The next media type that will play.</param>
|
|
<param name="positionTicks">Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<response code="204">Playback stop recorded.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.OnPlaybackStoppedLegacy(System.Guid,System.Guid,System.String,System.String,System.Nullable{System.Int64},System.String,System.String)">
|
|
<summary>
|
|
Reports that a user has stopped playing an item.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="mediaSourceId">The id of the MediaSource.</param>
|
|
<param name="nextMediaType">The next media type that will play.</param>
|
|
<param name="positionTicks">Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<response code="204">Playback stop recorded.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PlaystateController.UpdatePlayedStatus(Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.BaseItem,System.Boolean,System.Nullable{System.DateTime})">
|
|
<summary>
|
|
Updates the played status.
|
|
</summary>
|
|
<param name="user">The user.</param>
|
|
<param name="item">The item.</param>
|
|
<param name="wasPlayed">if set to <c>true</c> [was played].</param>
|
|
<param name="datePlayed">The date played.</param>
|
|
<returns>Task.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.PluginsController">
|
|
<summary>
|
|
Plugins controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PluginsController.#ctor(MediaBrowser.Common.Updates.IInstallationManager,MediaBrowser.Common.Plugins.IPluginManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.PluginsController"/> class.
|
|
</summary>
|
|
<param name="installationManager">Instance of the <see cref="T:MediaBrowser.Common.Updates.IInstallationManager"/> interface.</param>
|
|
<param name="pluginManager">Instance of the <see cref="T:MediaBrowser.Common.Plugins.IPluginManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PluginsController.GetPlugins">
|
|
<summary>
|
|
Gets a list of currently installed plugins.
|
|
</summary>
|
|
<response code="200">Installed plugins returned.</response>
|
|
<returns>List of currently installed plugins.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PluginsController.EnablePlugin(System.Guid,System.Version)">
|
|
<summary>
|
|
Enables a disabled plugin.
|
|
</summary>
|
|
<param name="pluginId">Plugin id.</param>
|
|
<param name="version">Plugin version.</param>
|
|
<response code="204">Plugin enabled.</response>
|
|
<response code="404">Plugin not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the plugin could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PluginsController.DisablePlugin(System.Guid,System.Version)">
|
|
<summary>
|
|
Disable a plugin.
|
|
</summary>
|
|
<param name="pluginId">Plugin id.</param>
|
|
<param name="version">Plugin version.</param>
|
|
<response code="204">Plugin disabled.</response>
|
|
<response code="404">Plugin not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the plugin could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PluginsController.UninstallPluginByVersion(System.Guid,System.Version)">
|
|
<summary>
|
|
Uninstalls a plugin by version.
|
|
</summary>
|
|
<param name="pluginId">Plugin id.</param>
|
|
<param name="version">Plugin version.</param>
|
|
<response code="204">Plugin uninstalled.</response>
|
|
<response code="404">Plugin not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the plugin could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PluginsController.UninstallPlugin(System.Guid)">
|
|
<summary>
|
|
Uninstalls a plugin.
|
|
</summary>
|
|
<param name="pluginId">Plugin id.</param>
|
|
<response code="204">Plugin uninstalled.</response>
|
|
<response code="404">Plugin not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the plugin could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PluginsController.GetPluginConfiguration(System.Guid)">
|
|
<summary>
|
|
Gets plugin configuration.
|
|
</summary>
|
|
<param name="pluginId">Plugin id.</param>
|
|
<response code="200">Plugin configuration returned.</response>
|
|
<response code="404">Plugin not found or plugin configuration not found.</response>
|
|
<returns>Plugin configuration.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PluginsController.UpdatePluginConfiguration(System.Guid)">
|
|
<summary>
|
|
Updates plugin configuration.
|
|
</summary>
|
|
<remarks>
|
|
Accepts plugin configuration as JSON body.
|
|
</remarks>
|
|
<param name="pluginId">Plugin id.</param>
|
|
<response code="204">Plugin configuration updated.</response>
|
|
<response code="404">Plugin not found or plugin does not have configuration.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the plugin could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PluginsController.GetPluginImage(System.Guid,System.Version)">
|
|
<summary>
|
|
Gets a plugin's image.
|
|
</summary>
|
|
<param name="pluginId">Plugin id.</param>
|
|
<param name="version">Plugin version.</param>
|
|
<response code="200">Plugin image returned.</response>
|
|
<returns>Plugin's image.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.PluginsController.GetPluginManifest(System.Guid)">
|
|
<summary>
|
|
Gets a plugin's manifest.
|
|
</summary>
|
|
<param name="pluginId">Plugin id.</param>
|
|
<response code="204">Plugin manifest returned.</response>
|
|
<response code="404">Plugin not found.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Common.Plugins.PluginManifest"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the plugin could not be found.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.QuickConnectController">
|
|
<summary>
|
|
Quick connect controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.QuickConnectController.#ctor(MediaBrowser.Controller.QuickConnect.IQuickConnect,MediaBrowser.Controller.Net.IAuthorizationContext)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.QuickConnectController"/> class.
|
|
</summary>
|
|
<param name="quickConnect">Instance of the <see cref="T:MediaBrowser.Controller.QuickConnect.IQuickConnect"/> interface.</param>
|
|
<param name="authContext">Instance of the <see cref="T:MediaBrowser.Controller.Net.IAuthorizationContext"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.QuickConnectController.GetQuickConnectEnabled">
|
|
<summary>
|
|
Gets the current quick connect state.
|
|
</summary>
|
|
<response code="200">Quick connect state returned.</response>
|
|
<returns>Whether Quick Connect is enabled on the server or not.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.QuickConnectController.InitiateQuickConnect">
|
|
<summary>
|
|
Initiate a new quick connect request.
|
|
</summary>
|
|
<response code="200">Quick connect request successfully created.</response>
|
|
<response code="401">Quick connect is not active on this server.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.QuickConnect.QuickConnectResult"/> with a secret and code for future use or an error message.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.QuickConnectController.GetQuickConnectState(System.String)">
|
|
<summary>
|
|
Attempts to retrieve authentication information.
|
|
</summary>
|
|
<param name="secret">Secret previously returned from the Initiate endpoint.</param>
|
|
<response code="200">Quick connect result returned.</response>
|
|
<response code="404">Unknown quick connect secret.</response>
|
|
<returns>An updated <see cref="T:MediaBrowser.Model.QuickConnect.QuickConnectResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.QuickConnectController.AuthorizeQuickConnect(System.String,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Authorizes a pending quick connect request.
|
|
</summary>
|
|
<param name="code">Quick connect code to authorize.</param>
|
|
<param name="userId">The user the authorize. Access to the requested user is required.</param>
|
|
<response code="200">Quick connect result authorized successfully.</response>
|
|
<response code="403">Unknown user id.</response>
|
|
<returns>Boolean indicating if the authorization was successful.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.RemoteImageController">
|
|
<summary>
|
|
Remote Images Controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.RemoteImageController.#ctor(MediaBrowser.Controller.Providers.IProviderManager,MediaBrowser.Controller.IServerApplicationPaths,MediaBrowser.Controller.Library.ILibraryManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.RemoteImageController"/> class.
|
|
</summary>
|
|
<param name="providerManager">Instance of the <see cref="T:MediaBrowser.Controller.Providers.IProviderManager"/> interface.</param>
|
|
<param name="applicationPaths">Instance of the <see cref="T:MediaBrowser.Controller.IServerApplicationPaths"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.RemoteImageController.GetRemoteImages(System.Guid,System.Nullable{MediaBrowser.Model.Entities.ImageType},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Boolean)">
|
|
<summary>
|
|
Gets available remote images for an item.
|
|
</summary>
|
|
<param name="itemId">Item Id.</param>
|
|
<param name="type">The image type.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="providerName">Optional. The image provider to use.</param>
|
|
<param name="includeAllLanguages">Optional. Include all languages.</param>
|
|
<response code="200">Remote Images returned.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>Remote Image Result.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.RemoteImageController.GetRemoteImageProviders(System.Guid)">
|
|
<summary>
|
|
Gets available remote image providers for an item.
|
|
</summary>
|
|
<param name="itemId">Item Id.</param>
|
|
<response code="200">Returned remote image providers.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>List of remote image providers.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.RemoteImageController.DownloadRemoteImage(System.Guid,MediaBrowser.Model.Entities.ImageType,System.String)">
|
|
<summary>
|
|
Downloads a remote image for an item.
|
|
</summary>
|
|
<param name="itemId">Item Id.</param>
|
|
<param name="type">The image type.</param>
|
|
<param name="imageUrl">The image url.</param>
|
|
<response code="204">Remote image downloaded.</response>
|
|
<response code="404">Remote image not found.</response>
|
|
<returns>Download status.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.RemoteImageController.GetFullCachePath(System.String)">
|
|
<summary>
|
|
Gets the full cache path.
|
|
</summary>
|
|
<param name="filename">The filename.</param>
|
|
<returns>System.String.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.ScheduledTasksController">
|
|
<summary>
|
|
Scheduled Tasks Controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ScheduledTasksController.#ctor(MediaBrowser.Model.Tasks.ITaskManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.ScheduledTasksController"/> class.
|
|
</summary>
|
|
<param name="taskManager">Instance of the <see cref="T:MediaBrowser.Model.Tasks.ITaskManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ScheduledTasksController.GetTasks(System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Get tasks.
|
|
</summary>
|
|
<param name="isHidden">Optional filter tasks that are hidden, or not.</param>
|
|
<param name="isEnabled">Optional filter tasks that are enabled, or not.</param>
|
|
<response code="200">Scheduled tasks retrieved.</response>
|
|
<returns>The list of scheduled tasks.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ScheduledTasksController.GetTask(System.String)">
|
|
<summary>
|
|
Get task by id.
|
|
</summary>
|
|
<param name="taskId">Task Id.</param>
|
|
<response code="200">Task retrieved.</response>
|
|
<response code="404">Task not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the task on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the task could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ScheduledTasksController.StartTask(System.String)">
|
|
<summary>
|
|
Start specified task.
|
|
</summary>
|
|
<param name="taskId">Task Id.</param>
|
|
<response code="204">Task started.</response>
|
|
<response code="404">Task not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the file could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ScheduledTasksController.StopTask(System.String)">
|
|
<summary>
|
|
Stop specified task.
|
|
</summary>
|
|
<param name="taskId">Task Id.</param>
|
|
<response code="204">Task stopped.</response>
|
|
<response code="404">Task not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the file could not be found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.ScheduledTasksController.UpdateTask(System.String,MediaBrowser.Model.Tasks.TaskTriggerInfo[])">
|
|
<summary>
|
|
Update specified task triggers.
|
|
</summary>
|
|
<param name="taskId">Task Id.</param>
|
|
<param name="triggerInfos">Triggers.</param>
|
|
<response code="204">Task triggers updated.</response>
|
|
<response code="404">Task not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the file could not be found.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.SearchController">
|
|
<summary>
|
|
Search controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SearchController.#ctor(MediaBrowser.Controller.Library.ISearchEngine,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Drawing.IImageProcessor)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.SearchController"/> class.
|
|
</summary>
|
|
<param name="searchEngine">Instance of <see cref="T:MediaBrowser.Controller.Library.ISearchEngine"/> interface.</param>
|
|
<param name="libraryManager">Instance of <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="dtoService">Instance of <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="imageProcessor">Instance of <see cref="T:MediaBrowser.Controller.Drawing.IImageProcessor"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SearchController.GetSearchHints(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Guid},System.String,Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.MediaType[],System.Nullable{System.Guid},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Gets the search hint result.
|
|
</summary>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="userId">Optional. Supply a user id to search within a user's library or omit to search all.</param>
|
|
<param name="searchTerm">The search term to filter on.</param>
|
|
<param name="includeItemTypes">If specified, only results with the specified item types are returned. This allows multiple, comma delimited.</param>
|
|
<param name="excludeItemTypes">If specified, results with these item types are filtered out. This allows multiple, comma delimited.</param>
|
|
<param name="mediaTypes">If specified, only results with the specified media types are returned. This allows multiple, comma delimited.</param>
|
|
<param name="parentId">If specified, only children of the parent are returned.</param>
|
|
<param name="isMovie">Optional filter for movies.</param>
|
|
<param name="isSeries">Optional filter for series.</param>
|
|
<param name="isNews">Optional filter for news.</param>
|
|
<param name="isKids">Optional filter for kids.</param>
|
|
<param name="isSports">Optional filter for sports.</param>
|
|
<param name="includePeople">Optional filter whether to include people.</param>
|
|
<param name="includeMedia">Optional filter whether to include media.</param>
|
|
<param name="includeGenres">Optional filter whether to include genres.</param>
|
|
<param name="includeStudios">Optional filter whether to include studios.</param>
|
|
<param name="includeArtists">Optional filter whether to include artists.</param>
|
|
<response code="200">Search hint returned.</response>
|
|
<returns>An <see cref="T:MediaBrowser.Model.Search.SearchHintResult"/> with the results of the search.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SearchController.GetSearchHintResult(MediaBrowser.Controller.Library.SearchHintInfo)">
|
|
<summary>
|
|
Gets the search hint result.
|
|
</summary>
|
|
<param name="hintInfo">The hint info.</param>
|
|
<returns>SearchHintResult.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.SessionController">
|
|
<summary>
|
|
The session controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.#ctor(MediaBrowser.Controller.Session.ISessionManager,MediaBrowser.Controller.Library.IUserManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.SessionController"/> class.
|
|
</summary>
|
|
<param name="sessionManager">Instance of <see cref="T:MediaBrowser.Controller.Session.ISessionManager"/> interface.</param>
|
|
<param name="userManager">Instance of <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.GetSessions(System.Nullable{System.Guid},System.String,System.Nullable{System.Int32})">
|
|
<summary>
|
|
Gets a list of sessions.
|
|
</summary>
|
|
<param name="controllableByUserId">Filter by sessions that a given user is allowed to remote control.</param>
|
|
<param name="deviceId">Filter by device Id.</param>
|
|
<param name="activeWithinSeconds">Optional. Filter by sessions that were active in the last n seconds.</param>
|
|
<response code="200">List of sessions returned.</response>
|
|
<returns>An <see cref="T:System.Collections.Generic.IReadOnlyList`1"/> with the available sessions.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.DisplayContent(System.String,Jellyfin.Data.Enums.BaseItemKind,System.String,System.String)">
|
|
<summary>
|
|
Instructs a session to browse to an item or view.
|
|
</summary>
|
|
<param name="sessionId">The session Id.</param>
|
|
<param name="itemType">The type of item to browse to.</param>
|
|
<param name="itemId">The Id of the item.</param>
|
|
<param name="itemName">The name of the item.</param>
|
|
<response code="204">Instruction sent to session.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.Play(System.String,MediaBrowser.Model.Session.PlayCommand,System.Guid[],System.Nullable{System.Int64},System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
|
<summary>
|
|
Instructs a session to play an item.
|
|
</summary>
|
|
<param name="sessionId">The session id.</param>
|
|
<param name="playCommand">The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now.</param>
|
|
<param name="itemIds">The ids of the items to play, comma delimited.</param>
|
|
<param name="startPositionTicks">The starting position of the first item.</param>
|
|
<param name="mediaSourceId">Optional. The media source id.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to play.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to play.</param>
|
|
<param name="startIndex">Optional. The start index.</param>
|
|
<response code="204">Instruction sent to session.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.SendPlaystateCommand(System.String,MediaBrowser.Model.Session.PlaystateCommand,System.Nullable{System.Int64},System.String)">
|
|
<summary>
|
|
Issues a playstate command to a client.
|
|
</summary>
|
|
<param name="sessionId">The session id.</param>
|
|
<param name="command">The <see cref="T:MediaBrowser.Model.Session.PlaystateCommand"/>.</param>
|
|
<param name="seekPositionTicks">The optional position ticks.</param>
|
|
<param name="controllingUserId">The optional controlling user id.</param>
|
|
<response code="204">Playstate command sent to session.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.SendSystemCommand(System.String,MediaBrowser.Model.Session.GeneralCommandType)">
|
|
<summary>
|
|
Issues a system command to a client.
|
|
</summary>
|
|
<param name="sessionId">The session id.</param>
|
|
<param name="command">The command to send.</param>
|
|
<response code="204">System command sent to session.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.SendGeneralCommand(System.String,MediaBrowser.Model.Session.GeneralCommandType)">
|
|
<summary>
|
|
Issues a general command to a client.
|
|
</summary>
|
|
<param name="sessionId">The session id.</param>
|
|
<param name="command">The command to send.</param>
|
|
<response code="204">General command sent to session.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.SendFullGeneralCommand(System.String,MediaBrowser.Model.Session.GeneralCommand)">
|
|
<summary>
|
|
Issues a full general command to a client.
|
|
</summary>
|
|
<param name="sessionId">The session id.</param>
|
|
<param name="command">The <see cref="T:MediaBrowser.Model.Session.GeneralCommand"/>.</param>
|
|
<response code="204">Full general command sent to session.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.SendMessageCommand(System.String,MediaBrowser.Model.Session.MessageCommand)">
|
|
<summary>
|
|
Issues a command to a client to display a message to the user.
|
|
</summary>
|
|
<param name="sessionId">The session id.</param>
|
|
<param name="command">The <see cref="T:MediaBrowser.Model.Session.MessageCommand" /> object containing Header, Message Text, and TimeoutMs.</param>
|
|
<response code="204">Message sent.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.AddUserToSession(System.String,System.Guid)">
|
|
<summary>
|
|
Adds an additional user to a session.
|
|
</summary>
|
|
<param name="sessionId">The session id.</param>
|
|
<param name="userId">The user id.</param>
|
|
<response code="204">User added to session.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.RemoveUserFromSession(System.String,System.Guid)">
|
|
<summary>
|
|
Removes an additional user from a session.
|
|
</summary>
|
|
<param name="sessionId">The session id.</param>
|
|
<param name="userId">The user id.</param>
|
|
<response code="204">User removed from session.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.PostCapabilities(System.String,Jellyfin.Data.Enums.MediaType[],MediaBrowser.Model.Session.GeneralCommandType[],System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Updates capabilities for a device.
|
|
</summary>
|
|
<param name="id">The session id.</param>
|
|
<param name="playableMediaTypes">A list of playable media types, comma delimited. Audio, Video, Book, Photo.</param>
|
|
<param name="supportedCommands">A list of supported remote control commands, comma delimited.</param>
|
|
<param name="supportsMediaControl">Determines whether media can be played remotely..</param>
|
|
<param name="supportsPersistentIdentifier">Determines whether the device supports a unique identifier.</param>
|
|
<response code="204">Capabilities posted.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.PostFullCapabilities(System.String,MediaBrowser.Model.Dto.ClientCapabilitiesDto)">
|
|
<summary>
|
|
Updates capabilities for a device.
|
|
</summary>
|
|
<param name="id">The session id.</param>
|
|
<param name="capabilities">The <see cref="T:MediaBrowser.Model.Session.ClientCapabilities"/>.</param>
|
|
<response code="204">Capabilities updated.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.ReportViewing(System.String,System.String)">
|
|
<summary>
|
|
Reports that a session is viewing an item.
|
|
</summary>
|
|
<param name="sessionId">The session id.</param>
|
|
<param name="itemId">The item id.</param>
|
|
<response code="204">Session reported to server.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.ReportSessionEnded">
|
|
<summary>
|
|
Reports that a session has ended.
|
|
</summary>
|
|
<response code="204">Session end reported to server.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.GetAuthProviders">
|
|
<summary>
|
|
Get all auth providers.
|
|
</summary>
|
|
<response code="200">Auth providers retrieved.</response>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with the auth providers.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SessionController.GetPasswordResetProviders">
|
|
<summary>
|
|
Get all password reset providers.
|
|
</summary>
|
|
<response code="200">Password reset providers retrieved.</response>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with the password reset providers.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.StartupController">
|
|
<summary>
|
|
The startup wizard controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.StartupController.#ctor(MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Controller.Library.IUserManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.StartupController" /> class.
|
|
</summary>
|
|
<param name="config">The server configuration manager.</param>
|
|
<param name="userManager">The user manager.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.StartupController.CompleteWizard">
|
|
<summary>
|
|
Completes the startup wizard.
|
|
</summary>
|
|
<response code="204">Startup wizard completed.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.StartupController.GetStartupConfiguration">
|
|
<summary>
|
|
Gets the initial startup wizard configuration.
|
|
</summary>
|
|
<response code="200">Initial startup wizard configuration retrieved.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the initial startup wizard configuration.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.StartupController.UpdateInitialConfiguration(Jellyfin.Api.Models.StartupDtos.StartupConfigurationDto)">
|
|
<summary>
|
|
Sets the initial startup wizard configuration.
|
|
</summary>
|
|
<param name="startupConfiguration">The updated startup configuration.</param>
|
|
<response code="204">Configuration saved.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.StartupController.SetRemoteAccess(Jellyfin.Api.Models.StartupDtos.StartupRemoteAccessDto)">
|
|
<summary>
|
|
Sets remote access and UPnP.
|
|
</summary>
|
|
<param name="startupRemoteAccessDto">The startup remote access dto.</param>
|
|
<response code="204">Configuration saved.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.StartupController.GetFirstUser">
|
|
<summary>
|
|
Gets the first user.
|
|
</summary>
|
|
<response code="200">Initial user retrieved.</response>
|
|
<returns>The first user.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.StartupController.UpdateStartupUser(Jellyfin.Api.Models.StartupDtos.StartupUserDto)">
|
|
<summary>
|
|
Sets the user name and password.
|
|
</summary>
|
|
<param name="startupUserDto">The DTO containing username and password.</param>
|
|
<response code="204">Updated user name and password.</response>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous update operation.
|
|
The task result contains a <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.StudiosController">
|
|
<summary>
|
|
Studios controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.StudiosController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Dto.IDtoService)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.StudiosController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.StudiosController.GetStudios(System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Nullable{System.Guid},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Boolean)">
|
|
<summary>
|
|
Gets all studios from a given item, folder, or the entire library.
|
|
</summary>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="searchTerm">Optional. Search term.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="excludeItemTypes">Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
|
|
<param name="enableUserData">Optional, include user data.</param>
|
|
<param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="userId">User id.</param>
|
|
<param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a given input string.</param>
|
|
<param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</param>
|
|
<param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</param>
|
|
<param name="enableImages">Optional, include image information in output.</param>
|
|
<param name="enableTotalRecordCount">Total record count.</param>
|
|
<response code="200">Studios returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the studios.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.StudiosController.GetStudio(System.String,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets a studio by name.
|
|
</summary>
|
|
<param name="name">Studio name.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<response code="200">Studio returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the studio.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.SubtitleController">
|
|
<summary>
|
|
Subtitle controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.#ctor(MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Subtitles.ISubtitleManager,MediaBrowser.Controller.MediaEncoding.ISubtitleEncoder,MediaBrowser.Controller.Library.IMediaSourceManager,MediaBrowser.Controller.Providers.IProviderManager,MediaBrowser.Model.IO.IFileSystem,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.SubtitleController})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.SubtitleController"/> class.
|
|
</summary>
|
|
<param name="serverConfigurationManager">Instance of <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="subtitleManager">Instance of <see cref="T:MediaBrowser.Controller.Subtitles.ISubtitleManager"/> interface.</param>
|
|
<param name="subtitleEncoder">Instance of <see cref="T:MediaBrowser.Controller.MediaEncoding.ISubtitleEncoder"/> interface.</param>
|
|
<param name="mediaSourceManager">Instance of <see cref="T:MediaBrowser.Controller.Library.IMediaSourceManager"/> interface.</param>
|
|
<param name="providerManager">Instance of <see cref="T:MediaBrowser.Controller.Providers.IProviderManager"/> interface.</param>
|
|
<param name="fileSystem">Instance of <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
|
<param name="logger">Instance of <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.DeleteSubtitle(System.Guid,System.Int32)">
|
|
<summary>
|
|
Deletes an external subtitle file.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="index">The index of the subtitle file.</param>
|
|
<response code="204">Subtitle deleted.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.SearchRemoteSubtitles(System.Guid,System.String,System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Search remote subtitles.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="language">The language of the subtitles.</param>
|
|
<param name="isPerfectMatch">Optional. Only show subtitles which are a perfect match.</param>
|
|
<response code="200">Subtitles retrieved.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>An array of <see cref="T:MediaBrowser.Model.Providers.RemoteSubtitleInfo"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.DownloadRemoteSubtitles(System.Guid,System.String)">
|
|
<summary>
|
|
Downloads a remote subtitle.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="subtitleId">The subtitle id.</param>
|
|
<response code="204">Subtitle downloaded.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.GetRemoteSubtitles(System.String)">
|
|
<summary>
|
|
Gets the remote subtitles.
|
|
</summary>
|
|
<param name="subtitleId">The item id.</param>
|
|
<response code="200">File returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> with the subtitle file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.GetSubtitle(System.Guid,System.String,System.Int32,System.String,System.Nullable{System.Guid},System.String,System.Nullable{System.Int32},System.String,System.Nullable{System.Int64},System.Boolean,System.Boolean,System.Int64)">
|
|
<summary>
|
|
Gets subtitles in a specified format.
|
|
</summary>
|
|
<param name="routeItemId">The (route) item id.</param>
|
|
<param name="routeMediaSourceId">The (route) media source id.</param>
|
|
<param name="routeIndex">The (route) subtitle stream index.</param>
|
|
<param name="routeFormat">The (route) format of the returned subtitle.</param>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="mediaSourceId">The media source id.</param>
|
|
<param name="index">The subtitle stream index.</param>
|
|
<param name="format">The format of the returned subtitle.</param>
|
|
<param name="endPositionTicks">Optional. The end position of the subtitle in ticks.</param>
|
|
<param name="copyTimestamps">Optional. Whether to copy the timestamps.</param>
|
|
<param name="addVttTimeMap">Optional. Whether to add a VTT time map.</param>
|
|
<param name="startPositionTicks">The start position of the subtitle in ticks.</param>
|
|
<response code="200">File returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileContentResult"/> with the subtitle file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.GetSubtitleWithTicks(System.Guid,System.String,System.Int32,System.Int64,System.String,System.Nullable{System.Guid},System.String,System.Nullable{System.Int32},System.Nullable{System.Int64},System.String,System.Nullable{System.Int64},System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Gets subtitles in a specified format.
|
|
</summary>
|
|
<param name="routeItemId">The (route) item id.</param>
|
|
<param name="routeMediaSourceId">The (route) media source id.</param>
|
|
<param name="routeIndex">The (route) subtitle stream index.</param>
|
|
<param name="routeStartPositionTicks">The (route) start position of the subtitle in ticks.</param>
|
|
<param name="routeFormat">The (route) format of the returned subtitle.</param>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="mediaSourceId">The media source id.</param>
|
|
<param name="index">The subtitle stream index.</param>
|
|
<param name="startPositionTicks">The start position of the subtitle in ticks.</param>
|
|
<param name="format">The format of the returned subtitle.</param>
|
|
<param name="endPositionTicks">Optional. The end position of the subtitle in ticks.</param>
|
|
<param name="copyTimestamps">Optional. Whether to copy the timestamps.</param>
|
|
<param name="addVttTimeMap">Optional. Whether to add a VTT time map.</param>
|
|
<response code="200">File returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileContentResult"/> with the subtitle file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.GetSubtitlePlaylist(System.Guid,System.Int32,System.String,System.Int32)">
|
|
<summary>
|
|
Gets an HLS subtitle playlist.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="index">The subtitle stream index.</param>
|
|
<param name="mediaSourceId">The media source id.</param>
|
|
<param name="segmentLength">The subtitle segment length.</param>
|
|
<response code="200">Subtitle playlist retrieved.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileContentResult"/> with the HLS subtitle playlist.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.UploadSubtitle(System.Guid,Jellyfin.Api.Models.SubtitleDtos.UploadSubtitleDto)">
|
|
<summary>
|
|
Upload an external subtitle file.
|
|
</summary>
|
|
<param name="itemId">The item the subtitle belongs to.</param>
|
|
<param name="body">The request body.</param>
|
|
<response code="204">Subtitle uploaded.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.EncodeSubtitles(System.Guid,System.String,System.Int32,System.String,System.Int64,System.Nullable{System.Int64},System.Boolean)">
|
|
<summary>
|
|
Encodes a subtitle in the specified format.
|
|
</summary>
|
|
<param name="id">The media id.</param>
|
|
<param name="mediaSourceId">The source media id.</param>
|
|
<param name="index">The subtitle index.</param>
|
|
<param name="format">The format to convert to.</param>
|
|
<param name="startPositionTicks">The start position in ticks.</param>
|
|
<param name="endPositionTicks">The end position in ticks.</param>
|
|
<param name="copyTimestamps">Whether to copy the timestamps.</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> with the new subtitle file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.GetFallbackFontList">
|
|
<summary>
|
|
Gets a list of available fallback font files.
|
|
</summary>
|
|
<response code="200">Information retrieved.</response>
|
|
<returns>An array of <see cref="T:MediaBrowser.Model.Subtitles.FontFile"/> with the available font files.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SubtitleController.GetFallbackFont(System.String)">
|
|
<summary>
|
|
Gets a fallback font file.
|
|
</summary>
|
|
<param name="name">The name of the fallback font file to get.</param>
|
|
<response code="200">Fallback font file retrieved.</response>
|
|
<returns>The fallback font file.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.SuggestionsController">
|
|
<summary>
|
|
The suggestions controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SuggestionsController.#ctor(MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.SuggestionsController"/> class.
|
|
</summary>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SuggestionsController.GetSuggestions(System.Nullable{System.Guid},Jellyfin.Data.Enums.MediaType[],Jellyfin.Data.Enums.BaseItemKind[],System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean)">
|
|
<summary>
|
|
Gets suggestions.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="mediaType">The media types.</param>
|
|
<param name="type">The type.</param>
|
|
<param name="startIndex">Optional. The start index.</param>
|
|
<param name="limit">Optional. The limit.</param>
|
|
<param name="enableTotalRecordCount">Whether to enable the total record count.</param>
|
|
<response code="200">Suggestions returned.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the suggestions.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SuggestionsController.GetSuggestionsLegacy(System.Guid,Jellyfin.Data.Enums.MediaType[],Jellyfin.Data.Enums.BaseItemKind[],System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean)">
|
|
<summary>
|
|
Gets suggestions.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="mediaType">The media types.</param>
|
|
<param name="type">The type.</param>
|
|
<param name="startIndex">Optional. The start index.</param>
|
|
<param name="limit">Optional. The limit.</param>
|
|
<param name="enableTotalRecordCount">Whether to enable the total record count.</param>
|
|
<response code="200">Suggestions returned.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the suggestions.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.SyncPlayController">
|
|
<summary>
|
|
The sync play controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.#ctor(MediaBrowser.Controller.Session.ISessionManager,MediaBrowser.Controller.SyncPlay.ISyncPlayManager,MediaBrowser.Controller.Library.IUserManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.SyncPlayController"/> class.
|
|
</summary>
|
|
<param name="sessionManager">Instance of the <see cref="T:MediaBrowser.Controller.Session.ISessionManager"/> interface.</param>
|
|
<param name="syncPlayManager">Instance of the <see cref="T:MediaBrowser.Controller.SyncPlay.ISyncPlayManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayCreateGroup(Jellyfin.Api.Models.SyncPlayDtos.NewGroupRequestDto)">
|
|
<summary>
|
|
Create a new SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The settings of the new group.</param>
|
|
<response code="204">New group created.</response>
|
|
<returns>An <see cref="T:MediaBrowser.Model.SyncPlay.GroupInfoDto"/> for the created group.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayJoinGroup(Jellyfin.Api.Models.SyncPlayDtos.JoinGroupRequestDto)">
|
|
<summary>
|
|
Join an existing SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The group to join.</param>
|
|
<response code="204">Group join successful.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayLeaveGroup">
|
|
<summary>
|
|
Leave the joined SyncPlay group.
|
|
</summary>
|
|
<response code="204">Group leave successful.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayGetGroups">
|
|
<summary>
|
|
Gets all SyncPlay groups.
|
|
</summary>
|
|
<response code="200">Groups returned.</response>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the available SyncPlay groups.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayGetGroup(System.Guid)">
|
|
<summary>
|
|
Gets a SyncPlay group by id.
|
|
</summary>
|
|
<param name="id">The id of the group.</param>
|
|
<response code="200">Group returned.</response>
|
|
<returns>An <see cref="T:MediaBrowser.Model.SyncPlay.GroupInfoDto"/> for the requested group.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlaySetNewQueue(Jellyfin.Api.Models.SyncPlayDtos.PlayRequestDto)">
|
|
<summary>
|
|
Request to set new playlist in SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The new playlist to play in the group.</param>
|
|
<response code="204">Queue update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlaySetPlaylistItem(Jellyfin.Api.Models.SyncPlayDtos.SetPlaylistItemRequestDto)">
|
|
<summary>
|
|
Request to change playlist item in SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The new item to play.</param>
|
|
<response code="204">Queue update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayRemoveFromPlaylist(Jellyfin.Api.Models.SyncPlayDtos.RemoveFromPlaylistRequestDto)">
|
|
<summary>
|
|
Request to remove items from the playlist in SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The items to remove.</param>
|
|
<response code="204">Queue update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayMovePlaylistItem(Jellyfin.Api.Models.SyncPlayDtos.MovePlaylistItemRequestDto)">
|
|
<summary>
|
|
Request to move an item in the playlist in SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The new position for the item.</param>
|
|
<response code="204">Queue update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayQueue(Jellyfin.Api.Models.SyncPlayDtos.QueueRequestDto)">
|
|
<summary>
|
|
Request to queue items to the playlist of a SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The items to add.</param>
|
|
<response code="204">Queue update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayUnpause">
|
|
<summary>
|
|
Request unpause in SyncPlay group.
|
|
</summary>
|
|
<response code="204">Unpause update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayPause">
|
|
<summary>
|
|
Request pause in SyncPlay group.
|
|
</summary>
|
|
<response code="204">Pause update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayStop">
|
|
<summary>
|
|
Request stop in SyncPlay group.
|
|
</summary>
|
|
<response code="204">Stop update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlaySeek(Jellyfin.Api.Models.SyncPlayDtos.SeekRequestDto)">
|
|
<summary>
|
|
Request seek in SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The new playback position.</param>
|
|
<response code="204">Seek update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayBuffering(Jellyfin.Api.Models.SyncPlayDtos.BufferRequestDto)">
|
|
<summary>
|
|
Notify SyncPlay group that member is buffering.
|
|
</summary>
|
|
<param name="requestData">The player status.</param>
|
|
<response code="204">Group state update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayReady(Jellyfin.Api.Models.SyncPlayDtos.ReadyRequestDto)">
|
|
<summary>
|
|
Notify SyncPlay group that member is ready for playback.
|
|
</summary>
|
|
<param name="requestData">The player status.</param>
|
|
<response code="204">Group state update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlaySetIgnoreWait(Jellyfin.Api.Models.SyncPlayDtos.IgnoreWaitRequestDto)">
|
|
<summary>
|
|
Request SyncPlay group to ignore member during group-wait.
|
|
</summary>
|
|
<param name="requestData">The settings to set.</param>
|
|
<response code="204">Member state updated.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayNextItem(Jellyfin.Api.Models.SyncPlayDtos.NextItemRequestDto)">
|
|
<summary>
|
|
Request next item in SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The current item information.</param>
|
|
<response code="204">Next item update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayPreviousItem(Jellyfin.Api.Models.SyncPlayDtos.PreviousItemRequestDto)">
|
|
<summary>
|
|
Request previous item in SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The current item information.</param>
|
|
<response code="204">Previous item update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlaySetRepeatMode(Jellyfin.Api.Models.SyncPlayDtos.SetRepeatModeRequestDto)">
|
|
<summary>
|
|
Request to set repeat mode in SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The new repeat mode.</param>
|
|
<response code="204">Play queue update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlaySetShuffleMode(Jellyfin.Api.Models.SyncPlayDtos.SetShuffleModeRequestDto)">
|
|
<summary>
|
|
Request to set shuffle mode in SyncPlay group.
|
|
</summary>
|
|
<param name="requestData">The new shuffle mode.</param>
|
|
<response code="204">Play queue update sent to all group members.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SyncPlayController.SyncPlayPing(Jellyfin.Api.Models.SyncPlayDtos.PingRequestDto)">
|
|
<summary>
|
|
Update session ping.
|
|
</summary>
|
|
<param name="requestData">The new ping.</param>
|
|
<response code="204">Ping updated.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.SystemController">
|
|
<summary>
|
|
The system controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SystemController.#ctor(Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.SystemController},MediaBrowser.Controller.IServerApplicationHost,MediaBrowser.Controller.IServerApplicationPaths,MediaBrowser.Model.IO.IFileSystem,MediaBrowser.Common.Net.INetworkManager,MediaBrowser.Controller.ISystemManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.SystemController"/> class.
|
|
</summary>
|
|
<param name="logger">Instance of <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="appPaths">Instance of <see cref="T:MediaBrowser.Controller.IServerApplicationPaths"/> interface.</param>
|
|
<param name="appHost">Instance of <see cref="T:MediaBrowser.Controller.IServerApplicationHost"/> interface.</param>
|
|
<param name="fileSystem">Instance of <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
|
<param name="networkManager">Instance of <see cref="T:MediaBrowser.Common.Net.INetworkManager"/> interface.</param>
|
|
<param name="systemManager">Instance of <see cref="T:MediaBrowser.Controller.ISystemManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SystemController.GetSystemInfo">
|
|
<summary>
|
|
Gets information about the server.
|
|
</summary>
|
|
<response code="200">Information retrieved.</response>
|
|
<response code="403">User does not have permission to retrieve information.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.System.SystemInfo"/> with info about the system.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SystemController.GetSystemStorage">
|
|
<summary>
|
|
Gets information about the server.
|
|
</summary>
|
|
<response code="200">Information retrieved.</response>
|
|
<response code="403">User does not have permission to retrieve information.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.System.SystemInfo"/> with info about the system.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SystemController.GetPublicSystemInfo">
|
|
<summary>
|
|
Gets public information about the server.
|
|
</summary>
|
|
<response code="200">Information retrieved.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.System.PublicSystemInfo"/> with public info about the system.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SystemController.PingSystem">
|
|
<summary>
|
|
Pings the system.
|
|
</summary>
|
|
<response code="200">Information retrieved.</response>
|
|
<returns>The server name.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SystemController.RestartApplication">
|
|
<summary>
|
|
Restarts the application.
|
|
</summary>
|
|
<response code="204">Server restarted.</response>
|
|
<response code="403">User does not have permission to restart server.</response>
|
|
<returns>No content. Server restarted.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SystemController.ShutdownApplication">
|
|
<summary>
|
|
Shuts down the application.
|
|
</summary>
|
|
<response code="204">Server shut down.</response>
|
|
<response code="403">User does not have permission to shutdown server.</response>
|
|
<returns>No content. Server shut down.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SystemController.GetServerLogs">
|
|
<summary>
|
|
Gets a list of available server log files.
|
|
</summary>
|
|
<response code="200">Information retrieved.</response>
|
|
<response code="403">User does not have permission to get server logs.</response>
|
|
<returns>An array of <see cref="T:MediaBrowser.Model.System.LogFile"/> with the available log files.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SystemController.GetEndpointInfo">
|
|
<summary>
|
|
Gets information about the request endpoint.
|
|
</summary>
|
|
<response code="200">Information retrieved.</response>
|
|
<response code="403">User does not have permission to get endpoint information.</response>
|
|
<returns><see cref="T:MediaBrowser.Model.Net.EndPointInfo"/> with information about the endpoint.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.SystemController.GetLogFile(System.String)">
|
|
<summary>
|
|
Gets a log file.
|
|
</summary>
|
|
<param name="name">The name of the log file to get.</param>
|
|
<response code="200">Log file retrieved.</response>
|
|
<response code="403">User does not have permission to get log files.</response>
|
|
<response code="404">Could not find a log file with the name.</response>
|
|
<returns>The log file.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.TimeSyncController">
|
|
<summary>
|
|
The time sync controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TimeSyncController.GetUtcTime">
|
|
<summary>
|
|
Gets the current UTC time.
|
|
</summary>
|
|
<response code="200">Time returned.</response>
|
|
<returns>An <see cref="T:MediaBrowser.Model.SyncPlay.UtcTimeResponse"/> to sync the client and server time.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.TrailersController">
|
|
<summary>
|
|
The trailers controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TrailersController.#ctor(Jellyfin.Api.Controllers.ItemsController)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.TrailersController"/> class.
|
|
</summary>
|
|
<param name="itemsController">Instance of <see cref="T:Jellyfin.Api.Controllers.ItemsController"/>.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TrailersController.GetTrailers(System.Nullable{System.Guid},System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},MediaBrowser.Model.Entities.LocationType[],MediaBrowser.Model.Entities.LocationType[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Guid[],System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.String,Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],MediaBrowser.Model.Querying.ItemFilter[],System.Nullable{System.Boolean},Jellyfin.Data.Enums.MediaType[],MediaBrowser.Model.Entities.ImageType[],Jellyfin.Data.Enums.ItemSortBy[],System.Nullable{System.Boolean},System.String[],System.String[],System.String[],System.Int32[],System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.String,System.Guid[],System.String[],System.String[],System.String[],System.Guid[],System.Guid[],System.Guid[],System.Guid[],System.String[],System.Guid[],System.Guid[],MediaBrowser.Model.Entities.VideoType[],System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},MediaBrowser.Model.Entities.SeriesStatus[],System.String,System.String,System.String,System.Guid[],System.Guid[],System.Boolean,System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Finds movies and trailers similar to a given trailer.
|
|
</summary>
|
|
<param name="userId">The user id supplied as query parameter; this is required when not using an API key.</param>
|
|
<param name="maxOfficialRating">Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).</param>
|
|
<param name="hasThemeSong">Optional filter by items with theme songs.</param>
|
|
<param name="hasThemeVideo">Optional filter by items with theme videos.</param>
|
|
<param name="hasSubtitles">Optional filter by items with subtitles.</param>
|
|
<param name="hasSpecialFeature">Optional filter by items with special features.</param>
|
|
<param name="hasTrailer">Optional filter by items with trailers.</param>
|
|
<param name="adjacentTo">Optional. Return items that are siblings of a supplied item.</param>
|
|
<param name="parentIndexNumber">Optional filter by parent index number.</param>
|
|
<param name="hasParentalRating">Optional filter by items that have or do not have a parental rating.</param>
|
|
<param name="isHd">Optional filter by items that are HD or not.</param>
|
|
<param name="is4K">Optional filter by items that are 4K or not.</param>
|
|
<param name="locationTypes">Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.</param>
|
|
<param name="excludeLocationTypes">Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.</param>
|
|
<param name="isMissing">Optional filter by items that are missing episodes or not.</param>
|
|
<param name="isUnaired">Optional filter by items that are unaired episodes or not.</param>
|
|
<param name="minCommunityRating">Optional filter by minimum community rating.</param>
|
|
<param name="minCriticRating">Optional filter by minimum critic rating.</param>
|
|
<param name="minPremiereDate">Optional. The minimum premiere date. Format = ISO.</param>
|
|
<param name="minDateLastSaved">Optional. The minimum last saved date. Format = ISO.</param>
|
|
<param name="minDateLastSavedForUser">Optional. The minimum last saved date for the current user. Format = ISO.</param>
|
|
<param name="maxPremiereDate">Optional. The maximum premiere date. Format = ISO.</param>
|
|
<param name="hasOverview">Optional filter by items that have an overview or not.</param>
|
|
<param name="hasImdbId">Optional filter by items that have an IMDb id or not.</param>
|
|
<param name="hasTmdbId">Optional filter by items that have a TMDb id or not.</param>
|
|
<param name="hasTvdbId">Optional filter by items that have a TVDb id or not.</param>
|
|
<param name="isMovie">Optional filter for live tv movies.</param>
|
|
<param name="isSeries">Optional filter for live tv series.</param>
|
|
<param name="isNews">Optional filter for live tv news.</param>
|
|
<param name="isKids">Optional filter for live tv kids.</param>
|
|
<param name="isSports">Optional filter for live tv sports.</param>
|
|
<param name="excludeItemIds">Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="recursive">When searching within folders, this determines whether or not the search will be recursive. true/false.</param>
|
|
<param name="searchTerm">Optional. Filter based on a search term.</param>
|
|
<param name="sortOrder">Sort Order - Ascending, Descending.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. 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.</param>
|
|
<param name="excludeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="filters">Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.</param>
|
|
<param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
|
|
<param name="mediaTypes">Optional filter by MediaType. Allows multiple, comma delimited.</param>
|
|
<param name="imageTypes">Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
|
<param name="isPlayed">Optional filter by items that are played, or not.</param>
|
|
<param name="genres">Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.</param>
|
|
<param name="officialRatings">Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.</param>
|
|
<param name="tags">Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.</param>
|
|
<param name="years">Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.</param>
|
|
<param name="enableUserData">Optional, include user data.</param>
|
|
<param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="person">Optional. If specified, results will be filtered to include only those containing the specified person.</param>
|
|
<param name="personIds">Optional. If specified, results will be filtered to include only those containing the specified person id.</param>
|
|
<param name="personTypes">Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.</param>
|
|
<param name="studios">Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.</param>
|
|
<param name="artists">Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.</param>
|
|
<param name="excludeArtistIds">Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.</param>
|
|
<param name="artistIds">Optional. If specified, results will be filtered to include only those containing the specified artist id.</param>
|
|
<param name="albumArtistIds">Optional. If specified, results will be filtered to include only those containing the specified album artist id.</param>
|
|
<param name="contributingArtistIds">Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.</param>
|
|
<param name="albums">Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.</param>
|
|
<param name="albumIds">Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.</param>
|
|
<param name="ids">Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.</param>
|
|
<param name="videoTypes">Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.</param>
|
|
<param name="minOfficialRating">Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).</param>
|
|
<param name="isLocked">Optional filter by items that are locked.</param>
|
|
<param name="isPlaceHolder">Optional filter by items that are placeholders.</param>
|
|
<param name="hasOfficialRating">Optional filter by items that have official ratings.</param>
|
|
<param name="collapseBoxSetItems">Whether or not to hide items behind their boxsets.</param>
|
|
<param name="minWidth">Optional. Filter by the minimum width of the item.</param>
|
|
<param name="minHeight">Optional. Filter by the minimum height of the item.</param>
|
|
<param name="maxWidth">Optional. Filter by the maximum width of the item.</param>
|
|
<param name="maxHeight">Optional. Filter by the maximum height of the item.</param>
|
|
<param name="is3D">Optional filter by items that are 3D, or not.</param>
|
|
<param name="seriesStatus">Optional filter by Series Status. Allows multiple, comma delimited.</param>
|
|
<param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a given input string.</param>
|
|
<param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</param>
|
|
<param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</param>
|
|
<param name="studioIds">Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.</param>
|
|
<param name="genreIds">Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.</param>
|
|
<param name="enableTotalRecordCount">Optional. Enable the total record count.</param>
|
|
<param name="enableImages">Optional, include image information in output.</param>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the trailers.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.TrickplayController">
|
|
<summary>
|
|
Trickplay controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TrickplayController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Trickplay.ITrickplayManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.TrickplayController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/>.</param>
|
|
<param name="trickplayManager">Instance of <see cref="T:MediaBrowser.Controller.Trickplay.ITrickplayManager"/>.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TrickplayController.GetTrickplayHlsPlaylist(System.Guid,System.Int32,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets an image tiles playlist for trickplay.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="width">The width of a single tile.</param>
|
|
<param name="mediaSourceId">The media version id, if using an alternate version.</param>
|
|
<response code="200">Tiles playlist returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the trickplay playlist file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TrickplayController.GetTrickplayTileImage(System.Guid,System.Int32,System.Int32,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets a trickplay tile image.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="width">The width of a single tile.</param>
|
|
<param name="index">The index of the desired tile.</param>
|
|
<param name="mediaSourceId">The media version id, if using an alternate version.</param>
|
|
<response code="200">Tile image returned.</response>
|
|
<response code="200">Tile image not found at specified index.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the trickplay tiles image.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.TvShowsController">
|
|
<summary>
|
|
The tv shows controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TvShowsController.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.TV.ITVSeriesManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.TvShowsController"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="tvSeriesManager">Instance of the <see cref="T:MediaBrowser.Controller.TV.ITVSeriesManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TvShowsController.GetNextUp(System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Guid},System.Nullable{System.Guid},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Nullable{System.Boolean},System.Nullable{System.DateTime},System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Gets a list of next up episodes.
|
|
</summary>
|
|
<param name="userId">The user id of the user to get the next up episodes for.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="seriesId">Optional. Filter by series id.</param>
|
|
<param name="parentId">Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="nextUpDateCutoff">Optional. Starting date of shows to show in Next Up section.</param>
|
|
<param name="enableTotalRecordCount">Whether to enable the total records count. Defaults to true.</param>
|
|
<param name="enableResumable">Whether to include resumable episodes in next up results.</param>
|
|
<param name="enableRewatching">Whether to include watched episodes in next up results.</param>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the next up episodes.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TvShowsController.GetUpcomingEpisodes(System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Guid},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Gets a list of upcoming episodes.
|
|
</summary>
|
|
<param name="userId">The user id of the user to get the upcoming episodes for.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="parentId">Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the upcoming episodes.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TvShowsController.GetEpisodes(System.Guid,System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Int32},System.Nullable{System.Guid},System.Nullable{System.Boolean},System.Nullable{System.Guid},System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Nullable{System.Boolean},System.Nullable{Jellyfin.Data.Enums.ItemSortBy})">
|
|
<summary>
|
|
Gets episodes for a tv season.
|
|
</summary>
|
|
<param name="seriesId">The series id.</param>
|
|
<param name="userId">The user id.</param>
|
|
<param name="fields">Optional. 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, TrailerUrls.</param>
|
|
<param name="season">Optional filter by season number.</param>
|
|
<param name="seasonId">Optional. Filter by season id.</param>
|
|
<param name="isMissing">Optional. Filter by items that are missing episodes or not.</param>
|
|
<param name="adjacentTo">Optional. Return items that are siblings of a supplied item.</param>
|
|
<param name="startItemId">Optional. Skip through the list until a given item is found.</param>
|
|
<param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="enableImages">Optional, include image information in output.</param>
|
|
<param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the episodes on success or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the series was not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TvShowsController.GetSeasons(System.Guid,System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Guid},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Gets seasons for a tv series.
|
|
</summary>
|
|
<param name="seriesId">The series id.</param>
|
|
<param name="userId">The user id.</param>
|
|
<param name="fields">Optional. 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, TrailerUrls.</param>
|
|
<param name="isSpecialSeason">Optional. Filter by special season.</param>
|
|
<param name="isMissing">Optional. Filter by items that are missing episodes or not.</param>
|
|
<param name="adjacentTo">Optional. Return items that are siblings of a supplied item.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> on success or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the series was not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.TvShowsController.ApplyPaging(System.Collections.Generic.IEnumerable{MediaBrowser.Controller.Entities.BaseItem},System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
|
<summary>
|
|
Applies the paging.
|
|
</summary>
|
|
<param name="items">The items.</param>
|
|
<param name="startIndex">The start index.</param>
|
|
<param name="limit">The limit.</param>
|
|
<returns>IEnumerable{BaseItem}.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.UniversalAudioController">
|
|
<summary>
|
|
The universal audio controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UniversalAudioController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.UniversalAudioController},Jellyfin.Api.Helpers.MediaInfoHelper,Jellyfin.Api.Helpers.AudioHelper,Jellyfin.Api.Helpers.DynamicHlsHelper,MediaBrowser.Controller.Library.IUserManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.UniversalAudioController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="mediaInfoHelper">Instance of <see cref="T:Jellyfin.Api.Helpers.MediaInfoHelper"/>.</param>
|
|
<param name="audioHelper">Instance of <see cref="T:Jellyfin.Api.Helpers.AudioHelper"/>.</param>
|
|
<param name="dynamicHlsHelper">Instance of <see cref="T:Jellyfin.Api.Helpers.DynamicHlsHelper"/>.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UniversalAudioController.GetUniversalAudioStream(System.Guid,System.String[],System.String,System.String,System.Nullable{System.Guid},System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.String,System.Nullable{Jellyfin.Data.Enums.MediaStreamProtocol},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Gets an audio stream.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="container">Optional. The audio container.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="userId">Optional. The user id.</param>
|
|
<param name="audioCodec">Optional. The audio codec to transcode to.</param>
|
|
<param name="maxAudioChannels">Optional. The maximum number of audio channels.</param>
|
|
<param name="transcodingAudioChannels">Optional. The number of how many audio channels to transcode to.</param>
|
|
<param name="maxStreamingBitrate">Optional. The maximum streaming bitrate.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="transcodingContainer">Optional. The container to transcode to.</param>
|
|
<param name="transcodingProtocol">Optional. The transcoding protocol.</param>
|
|
<param name="maxAudioSampleRate">Optional. The maximum audio sample rate.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="enableRemoteMedia">Optional. Whether to enable remote media.</param>
|
|
<param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
|
|
<param name="enableRedirection">Whether to enable redirection. Defaults to true.</param>
|
|
<response code="200">Audio stream returned.</response>
|
|
<response code="302">Redirected to remote audio stream.</response>
|
|
<response code="404">Item not found.</response>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing the audio file.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.UserController">
|
|
<summary>
|
|
User controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Session.ISessionManager,MediaBrowser.Common.Net.INetworkManager,MediaBrowser.Controller.Devices.IDeviceManager,MediaBrowser.Controller.Net.IAuthorizationContext,MediaBrowser.Controller.Configuration.IServerConfigurationManager,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Controllers.UserController},MediaBrowser.Controller.QuickConnect.IQuickConnect,MediaBrowser.Controller.Playlists.IPlaylistManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.UserController"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="sessionManager">Instance of the <see cref="T:MediaBrowser.Controller.Session.ISessionManager"/> interface.</param>
|
|
<param name="networkManager">Instance of the <see cref="T:MediaBrowser.Common.Net.INetworkManager"/> interface.</param>
|
|
<param name="deviceManager">Instance of the <see cref="T:MediaBrowser.Controller.Devices.IDeviceManager"/> interface.</param>
|
|
<param name="authContext">Instance of the <see cref="T:MediaBrowser.Controller.Net.IAuthorizationContext"/> interface.</param>
|
|
<param name="config">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger"/> interface.</param>
|
|
<param name="quickConnectManager">Instance of the <see cref="T:MediaBrowser.Controller.QuickConnect.IQuickConnect"/> interface.</param>
|
|
<param name="playlistManager">Instance of the <see cref="T:MediaBrowser.Controller.Playlists.IPlaylistManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.GetUsers(System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Gets a list of users.
|
|
</summary>
|
|
<param name="isHidden">Optional filter by IsHidden=true or false.</param>
|
|
<param name="isDisabled">Optional filter by IsDisabled=true or false.</param>
|
|
<response code="200">Users returned.</response>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the users.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.GetPublicUsers">
|
|
<summary>
|
|
Gets a list of publicly visible users for display on a login screen.
|
|
</summary>
|
|
<response code="200">Public users returned.</response>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the public users.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.GetUserById(System.Guid)">
|
|
<summary>
|
|
Gets a user by Id.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<response code="200">User returned.</response>
|
|
<response code="404">User not found.</response>
|
|
<returns>An <see cref="T:MediaBrowser.Model.Dto.UserDto"/> with information about the user or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the user was not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.DeleteUser(System.Guid)">
|
|
<summary>
|
|
Deletes a user.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<response code="204">User deleted.</response>
|
|
<response code="404">User not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the user was not found.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.AuthenticateUser(System.Guid,System.String)">
|
|
<summary>
|
|
Authenticates a user.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="pw">The password as plain text.</param>
|
|
<response code="200">User authenticated.</response>
|
|
<response code="403">Sha1-hashed password only is not allowed.</response>
|
|
<response code="404">User not found.</response>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing an <see cref="T:MediaBrowser.Controller.Authentication.AuthenticationResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName)">
|
|
<summary>
|
|
Authenticates a user by name.
|
|
</summary>
|
|
<param name="request">The <see cref="M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName)"/> request.</param>
|
|
<response code="200">User authenticated.</response>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing an <see cref="T:MediaBrowser.Controller.Session.AuthenticationRequest"/> with information about the new session.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.AuthenticateWithQuickConnect(Jellyfin.Api.Models.UserDtos.QuickConnectDto)">
|
|
<summary>
|
|
Authenticates a user with quick connect.
|
|
</summary>
|
|
<param name="request">The <see cref="T:Jellyfin.Api.Models.UserDtos.QuickConnectDto"/> request.</param>
|
|
<response code="200">User authenticated.</response>
|
|
<response code="400">Missing token.</response>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing an <see cref="T:MediaBrowser.Controller.Session.AuthenticationRequest"/> with information about the new session.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword)">
|
|
<summary>
|
|
Updates a user's password.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="request">The <see cref="M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword)"/> request.</param>
|
|
<response code="204">Password successfully reset.</response>
|
|
<response code="403">User is not allowed to update the password.</response>
|
|
<response code="404">User not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success or a <see cref="T:Microsoft.AspNetCore.Mvc.ForbidResult"/> or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> on failure.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.UpdateUserPasswordLegacy(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword)">
|
|
<summary>
|
|
Updates a user's password.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="request">The <see cref="M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword)"/> request.</param>
|
|
<response code="204">Password successfully reset.</response>
|
|
<response code="403">User is not allowed to update the password.</response>
|
|
<response code="404">User not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success or a <see cref="T:Microsoft.AspNetCore.Mvc.ForbidResult"/> or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> on failure.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.UpdateUser(System.Nullable{System.Guid},MediaBrowser.Model.Dto.UserDto)">
|
|
<summary>
|
|
Updates a user.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="updateUser">The updated user model.</param>
|
|
<response code="204">User updated.</response>
|
|
<response code="400">User information was not supplied.</response>
|
|
<response code="403">User update forbidden.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success or a <see cref="T:Microsoft.AspNetCore.Mvc.BadRequestResult"/> or a <see cref="T:Microsoft.AspNetCore.Mvc.ForbidResult"/> on failure.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.UpdateUserLegacy(System.Guid,MediaBrowser.Model.Dto.UserDto)">
|
|
<summary>
|
|
Updates a user.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="updateUser">The updated user model.</param>
|
|
<response code="204">User updated.</response>
|
|
<response code="400">User information was not supplied.</response>
|
|
<response code="403">User update forbidden.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success or a <see cref="T:Microsoft.AspNetCore.Mvc.BadRequestResult"/> or a <see cref="T:Microsoft.AspNetCore.Mvc.ForbidResult"/> on failure.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.UpdateUserPolicy(System.Guid,MediaBrowser.Model.Users.UserPolicy)">
|
|
<summary>
|
|
Updates a user policy.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="newPolicy">The new user policy.</param>
|
|
<response code="204">User policy updated.</response>
|
|
<response code="400">User policy was not supplied.</response>
|
|
<response code="403">User policy update forbidden.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success or a <see cref="T:Microsoft.AspNetCore.Mvc.BadRequestResult"/> or a <see cref="T:Microsoft.AspNetCore.Mvc.ForbidResult"/> on failure..</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.UpdateUserConfiguration(System.Nullable{System.Guid},MediaBrowser.Model.Configuration.UserConfiguration)">
|
|
<summary>
|
|
Updates a user configuration.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="userConfig">The new user configuration.</param>
|
|
<response code="204">User configuration updated.</response>
|
|
<response code="403">User configuration update forbidden.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.UpdateUserConfigurationLegacy(System.Guid,MediaBrowser.Model.Configuration.UserConfiguration)">
|
|
<summary>
|
|
Updates a user configuration.
|
|
</summary>
|
|
<param name="userId">The user id.</param>
|
|
<param name="userConfig">The new user configuration.</param>
|
|
<response code="204">User configuration updated.</response>
|
|
<response code="403">User configuration update forbidden.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.CreateUserByName(Jellyfin.Api.Models.UserDtos.CreateUserByName)">
|
|
<summary>
|
|
Creates a user.
|
|
</summary>
|
|
<param name="request">The create user by name request body.</param>
|
|
<response code="200">User created.</response>
|
|
<returns>An <see cref="T:MediaBrowser.Model.Dto.UserDto"/> of the new user.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.ForgotPassword(Jellyfin.Api.Models.UserDtos.ForgotPasswordDto)">
|
|
<summary>
|
|
Initiates the forgot password process for a local user.
|
|
</summary>
|
|
<param name="forgotPasswordRequest">The forgot password request containing the entered username.</param>
|
|
<response code="200">Password reset process started.</response>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing a <see cref="T:MediaBrowser.Model.Users.ForgotPasswordResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.ForgotPasswordPin(Jellyfin.Api.Models.UserDtos.ForgotPasswordPinDto)">
|
|
<summary>
|
|
Redeems a forgot password pin.
|
|
</summary>
|
|
<param name="forgotPasswordPinRequest">The forgot password pin request containing the entered pin.</param>
|
|
<response code="200">Pin reset process started.</response>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing a <see cref="T:MediaBrowser.Model.Users.PinRedeemResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserController.GetCurrentUser">
|
|
<summary>
|
|
Gets the user based on auth token.
|
|
</summary>
|
|
<response code="200">User returned.</response>
|
|
<response code="400">Token is not owned by a user.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Dto.UserDto"/> for the authenticated user.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.UserLibraryController">
|
|
<summary>
|
|
User library controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.IUserDataManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Library.IUserViewManager,MediaBrowser.Model.IO.IFileSystem)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.UserLibraryController"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="userDataRepository">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserDataManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="userViewManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserViewManager"/> interface.</param>
|
|
<param name="fileSystem">Instance of the <see cref="T:MediaBrowser.Model.IO.IFileSystem"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetItem(System.Nullable{System.Guid},System.Guid)">
|
|
<summary>
|
|
Gets an item from a user's library.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Item returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the item.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetItemLegacy(System.Guid,System.Guid)">
|
|
<summary>
|
|
Gets an item from a user's library.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Item returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the item.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetRootFolder(System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets the root folder from a user's library.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<response code="200">Root folder returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the user's root folder.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetRootFolderLegacy(System.Guid)">
|
|
<summary>
|
|
Gets the root folder from a user's library.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<response code="200">Root folder returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the user's root folder.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetIntros(System.Nullable{System.Guid},System.Guid)">
|
|
<summary>
|
|
Gets intros to play before the main media item plays.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Intros returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the intros to play.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetIntrosLegacy(System.Guid,System.Guid)">
|
|
<summary>
|
|
Gets intros to play before the main media item plays.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Intros returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the intros to play.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.MarkFavoriteItem(System.Nullable{System.Guid},System.Guid)">
|
|
<summary>
|
|
Marks an item as a favorite.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Item marked as favorite.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.MarkFavoriteItemLegacy(System.Guid,System.Guid)">
|
|
<summary>
|
|
Marks an item as a favorite.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Item marked as favorite.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.UnmarkFavoriteItem(System.Nullable{System.Guid},System.Guid)">
|
|
<summary>
|
|
Unmarks item as a favorite.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Item unmarked as favorite.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.UnmarkFavoriteItemLegacy(System.Guid,System.Guid)">
|
|
<summary>
|
|
Unmarks item as a favorite.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Item unmarked as favorite.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.DeleteUserItemRating(System.Nullable{System.Guid},System.Guid)">
|
|
<summary>
|
|
Deletes a user's saved personal rating for an item.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Personal rating removed.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.DeleteUserItemRatingLegacy(System.Guid,System.Guid)">
|
|
<summary>
|
|
Deletes a user's saved personal rating for an item.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Personal rating removed.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Updates a user's rating for an item.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="likes">Whether this <see cref="M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean})" /> is likes.</param>
|
|
<response code="200">Item rating updated.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRatingLegacy(System.Guid,System.Guid,System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Updates a user's rating for an item.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<param name="likes">Whether this <see cref="M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean})" /> is likes.</param>
|
|
<response code="200">Item rating updated.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the <see cref="T:MediaBrowser.Model.Dto.UserItemDataDto"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetLocalTrailers(System.Nullable{System.Guid},System.Guid)">
|
|
<summary>
|
|
Gets local trailers for an item.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the item's local trailers.</response>
|
|
<returns>The items local trailers.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetLocalTrailersLegacy(System.Guid,System.Guid)">
|
|
<summary>
|
|
Gets local trailers for an item.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the item's local trailers.</response>
|
|
<returns>The items local trailers.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetSpecialFeatures(System.Nullable{System.Guid},System.Guid)">
|
|
<summary>
|
|
Gets special features for an item.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Special features returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the special features.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetSpecialFeaturesLegacy(System.Guid,System.Guid)">
|
|
<summary>
|
|
Gets special features for an item.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="itemId">Item id.</param>
|
|
<response code="200">Special features returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the special features.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetLatestMedia(System.Nullable{System.Guid},System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Nullable{System.Boolean},System.Int32,System.Boolean)">
|
|
<summary>
|
|
Gets latest media.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="isPlayed">Filter by items that are played, or not.</param>
|
|
<param name="enableImages">Optional. include image information in output.</param>
|
|
<param name="imageTypeLimit">Optional. the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="enableUserData">Optional. include user data.</param>
|
|
<param name="limit">Return item limit.</param>
|
|
<param name="groupItems">Whether or not to group items into a parent container.</param>
|
|
<response code="200">Latest media returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the latest media.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.GetLatestMediaLegacy(System.Guid,System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Nullable{System.Boolean},System.Int32,System.Boolean)">
|
|
<summary>
|
|
Gets latest media.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="isPlayed">Filter by items that are played, or not.</param>
|
|
<param name="enableImages">Optional. include image information in output.</param>
|
|
<param name="imageTypeLimit">Optional. the max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="enableUserData">Optional. include user data.</param>
|
|
<param name="limit">Return item limit.</param>
|
|
<param name="groupItems">Whether or not to group items into a parent container.</param>
|
|
<response code="200">Latest media returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the latest media.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.MarkFavorite(Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.BaseItem,System.Boolean)">
|
|
<summary>
|
|
Marks the favorite.
|
|
</summary>
|
|
<param name="user">The user.</param>
|
|
<param name="item">The item.</param>
|
|
<param name="isFavorite">if set to <c>true</c> [is favorite].</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRatingInternal(Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.BaseItem,System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Updates the user item rating.
|
|
</summary>
|
|
<param name="user">The user.</param>
|
|
<param name="item">The item.</param>
|
|
<param name="likes">if set to <c>true</c> [likes].</param>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.UserViewsController">
|
|
<summary>
|
|
User views controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserViewsController.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.IUserViewManager,MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Library.ILibraryManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.UserViewsController"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="userViewManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserViewManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserViewsController.GetUserViews(System.Nullable{System.Guid},System.Nullable{System.Boolean},System.Nullable{Jellyfin.Data.Enums.CollectionType}[],System.Boolean)">
|
|
<summary>
|
|
Get user views.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="includeExternalContent">Whether or not to include external views such as channels or live tv.</param>
|
|
<param name="presetViews">Preset views.</param>
|
|
<param name="includeHidden">Whether or not to include hidden content.</param>
|
|
<response code="200">User views returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the user views.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserViewsController.GetUserViewsLegacy(System.Guid,System.Nullable{System.Boolean},System.Nullable{Jellyfin.Data.Enums.CollectionType}[],System.Boolean)">
|
|
<summary>
|
|
Get user views.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<param name="includeExternalContent">Whether or not to include external views such as channels or live tv.</param>
|
|
<param name="presetViews">Preset views.</param>
|
|
<param name="includeHidden">Whether or not to include hidden content.</param>
|
|
<response code="200">User views returned.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the user views.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserViewsController.GetGroupingOptions(System.Nullable{System.Guid})">
|
|
<summary>
|
|
Get user view grouping options.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<response code="200">User view grouping options returned.</response>
|
|
<response code="404">User not found.</response>
|
|
<returns>
|
|
An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the user view grouping options
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if user not found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.UserViewsController.GetGroupingOptionsLegacy(System.Guid)">
|
|
<summary>
|
|
Get user view grouping options.
|
|
</summary>
|
|
<param name="userId">User id.</param>
|
|
<response code="200">User view grouping options returned.</response>
|
|
<response code="404">User not found.</response>
|
|
<returns>
|
|
An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the user view grouping options
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if user not found.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.VideoAttachmentsController">
|
|
<summary>
|
|
Attachments controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.VideoAttachmentsController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.MediaEncoding.IAttachmentExtractor)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.VideoAttachmentsController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="attachmentExtractor">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.IAttachmentExtractor"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.VideoAttachmentsController.GetAttachment(System.Guid,System.String,System.Int32)">
|
|
<summary>
|
|
Get video attachment.
|
|
</summary>
|
|
<param name="videoId">Video ID.</param>
|
|
<param name="mediaSourceId">Media Source ID.</param>
|
|
<param name="index">Attachment Index.</param>
|
|
<response code="200">Attachment retrieved.</response>
|
|
<response code="404">Video or attachment not found.</response>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.FileStreamResult"/> containing the attachment stream on success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the attachment could not be found.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.VideosController">
|
|
<summary>
|
|
The videos controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.VideosController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Library.IMediaSourceManager,MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Controller.MediaEncoding.IMediaEncoder,MediaBrowser.Controller.MediaEncoding.ITranscodeManager,System.Net.Http.IHttpClientFactory,MediaBrowser.Controller.MediaEncoding.EncodingHelper)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.VideosController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
<param name="mediaSourceManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IMediaSourceManager"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="mediaEncoder">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.IMediaEncoder"/> interface.</param>
|
|
<param name="transcodeManager">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.ITranscodeManager"/> interface.</param>
|
|
<param name="httpClientFactory">Instance of the <see cref="T:System.Net.Http.IHttpClientFactory"/> interface.</param>
|
|
<param name="encodingHelper">Instance of <see cref="T:MediaBrowser.Controller.MediaEncoding.EncodingHelper"/>.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.VideosController.GetAdditionalPart(System.Guid,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets additional parts for a video.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<response code="200">Additional parts returned.</response>
|
|
<returns>A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> with the parts.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.VideosController.DeleteAlternateSources(System.Guid)">
|
|
<summary>
|
|
Removes alternate video sources.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<response code="204">Alternate sources deleted.</response>
|
|
<response code="404">Video not found.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success, or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if the video doesn't exist.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.VideosController.MergeVersions(System.Guid[])">
|
|
<summary>
|
|
Merges videos into a single record.
|
|
</summary>
|
|
<param name="ids">Item id list. This allows multiple, comma delimited.</param>
|
|
<response code="204">Videos merged.</response>
|
|
<response code="400">Supply at least 2 video ids.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.NoContentResult"/> indicating success, or a <see cref="T:Microsoft.AspNetCore.Mvc.BadRequestResult"/> if less than two ids were supplied.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.VideosController.GetVideoStream(System.Guid,System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.SubtitleDeliveryMethod},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.EncodingContext},System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean)">
|
|
<summary>
|
|
Gets a video stream.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="container">The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. </param>
|
|
<param name="static">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.</param>
|
|
<param name="params">The streaming parameters.</param>
|
|
<param name="tag">The tag.</param>
|
|
<param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<param name="segmentLength">The segment length.</param>
|
|
<param name="minSegments">The minimum number of segments.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.</param>
|
|
<param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
|
|
<param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
|
|
<param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
|
|
<param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
|
|
<param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
|
|
<param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
|
|
<param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
|
|
<param name="maxWidth">Optional. The maximum horizontal resolution of the encoded video.</param>
|
|
<param name="maxHeight">Optional. The maximum vertical resolution of the encoded video.</param>
|
|
<param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
|
|
<param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
|
|
<param name="maxRefFrames">Optional.</param>
|
|
<param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
|
|
<param name="requireAvc">Optional. Whether to require avc.</param>
|
|
<param name="deInterlace">Optional. Whether to deinterlace the video.</param>
|
|
<param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
|
|
<param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
|
|
<param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
|
|
<param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.</param>
|
|
<param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
|
|
<param name="transcodeReasons">Optional. The transcoding reason.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
|
|
<param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
|
|
<param name="context">Optional. The <see cref="T:MediaBrowser.Model.Dlna.EncodingContext"/>.</param>
|
|
<param name="streamOptions">Optional. The streaming options.</param>
|
|
<param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
|
|
<response code="200">Video stream returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the audio file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.VideosController.GetVideoStreamByContainer(System.Guid,System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.SubtitleDeliveryMethod},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{MediaBrowser.Model.Dlna.EncodingContext},System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean)">
|
|
<summary>
|
|
Gets a video stream.
|
|
</summary>
|
|
<param name="itemId">The item id.</param>
|
|
<param name="container">The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. </param>
|
|
<param name="static">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.</param>
|
|
<param name="params">The streaming parameters.</param>
|
|
<param name="tag">The tag.</param>
|
|
<param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<param name="segmentContainer">The segment container.</param>
|
|
<param name="segmentLength">The segment length.</param>
|
|
<param name="minSegments">The minimum number of segments.</param>
|
|
<param name="mediaSourceId">The media version id, if playing an alternate version.</param>
|
|
<param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
|
|
<param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.</param>
|
|
<param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
|
|
<param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
|
|
<param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
|
|
<param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
|
|
<param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
|
|
<param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
|
|
<param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
|
|
<param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
|
|
<param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
|
|
<param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
|
|
<param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
|
|
<param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
|
|
<param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
|
|
<param name="maxWidth">Optional. The maximum horizontal resolution of the encoded video.</param>
|
|
<param name="maxHeight">Optional. The maximum vertical resolution of the encoded video.</param>
|
|
<param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
|
|
<param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
|
|
<param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
|
|
<param name="maxRefFrames">Optional.</param>
|
|
<param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
|
|
<param name="requireAvc">Optional. Whether to require avc.</param>
|
|
<param name="deInterlace">Optional. Whether to deinterlace the video.</param>
|
|
<param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
|
|
<param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
|
|
<param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
|
|
<param name="liveStreamId">The live stream id.</param>
|
|
<param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
|
|
<param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.</param>
|
|
<param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
|
|
<param name="transcodeReasons">Optional. The transcoding reason.</param>
|
|
<param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
|
|
<param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
|
|
<param name="context">Optional. The <see cref="T:MediaBrowser.Model.Dlna.EncodingContext"/>.</param>
|
|
<param name="streamOptions">Optional. The streaming options.</param>
|
|
<param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
|
|
<response code="200">Video stream returned.</response>
|
|
<returns>A <see cref="T:Microsoft.AspNetCore.Mvc.FileResult"/> containing the audio file.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Controllers.YearsController">
|
|
<summary>
|
|
Years controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.YearsController.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Dto.IDtoService)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Controllers.YearsController"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="dtoService">Instance of the <see cref="T:MediaBrowser.Controller.Dto.IDtoService"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.YearsController.GetYears(System.Nullable{System.Int32},System.Nullable{System.Int32},Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable{System.Guid},MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.MediaType[],Jellyfin.Data.Enums.ItemSortBy[],System.Nullable{System.Boolean},System.Nullable{System.Int32},MediaBrowser.Model.Entities.ImageType[],System.Nullable{System.Guid},System.Boolean,System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Get years.
|
|
</summary>
|
|
<param name="startIndex">Skips over a given number of items within the results. Use for paging.</param>
|
|
<param name="limit">Optional. The maximum number of records to return.</param>
|
|
<param name="sortOrder">Sort Order - Ascending,Descending.</param>
|
|
<param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
<param name="fields">Optional. Specify additional fields of information to return in the output.</param>
|
|
<param name="excludeItemTypes">Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="includeItemTypes">Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.</param>
|
|
<param name="mediaTypes">Optional. Filter by MediaType. Allows multiple, comma delimited.</param>
|
|
<param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
|
<param name="enableUserData">Optional. Include user data.</param>
|
|
<param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
<param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
<param name="userId">User Id.</param>
|
|
<param name="recursive">Search recursively.</param>
|
|
<param name="enableImages">Optional. Include image information in output.</param>
|
|
<response code="200">Year query returned.</response>
|
|
<returns> A <see cref="T:MediaBrowser.Model.Querying.QueryResult`1"/> containing the year result.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Controllers.YearsController.GetYear(System.Int32,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Gets a year.
|
|
</summary>
|
|
<param name="year">The year.</param>
|
|
<param name="userId">Optional. Filter by user id, and attach user data.</param>
|
|
<response code="200">Year returned.</response>
|
|
<response code="404">Year not found.</response>
|
|
<returns>
|
|
An <see cref="T:Microsoft.AspNetCore.Mvc.OkResult"/> containing the year,
|
|
or a <see cref="T:Microsoft.AspNetCore.Mvc.NotFoundResult"/> if year not found.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Extensions.ClaimsPrincipalExtensions">
|
|
<summary>
|
|
Extensions for <see cref="T:System.Security.Claims.ClaimsPrincipal"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Extensions.ClaimsPrincipalExtensions.GetUserId(System.Security.Claims.ClaimsPrincipal)">
|
|
<summary>
|
|
Get user id from claims.
|
|
</summary>
|
|
<param name="user">Current claims principal.</param>
|
|
<returns>User id.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Extensions.ClaimsPrincipalExtensions.GetDeviceId(System.Security.Claims.ClaimsPrincipal)">
|
|
<summary>
|
|
Get device id from claims.
|
|
</summary>
|
|
<param name="user">Current claims principal.</param>
|
|
<returns>Device id.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Extensions.ClaimsPrincipalExtensions.GetDevice(System.Security.Claims.ClaimsPrincipal)">
|
|
<summary>
|
|
Get device from claims.
|
|
</summary>
|
|
<param name="user">Current claims principal.</param>
|
|
<returns>Device.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Extensions.ClaimsPrincipalExtensions.GetClient(System.Security.Claims.ClaimsPrincipal)">
|
|
<summary>
|
|
Get client from claims.
|
|
</summary>
|
|
<param name="user">Current claims principal.</param>
|
|
<returns>Client.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Extensions.ClaimsPrincipalExtensions.GetVersion(System.Security.Claims.ClaimsPrincipal)">
|
|
<summary>
|
|
Get version from claims.
|
|
</summary>
|
|
<param name="user">Current claims principal.</param>
|
|
<returns>Version.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Extensions.ClaimsPrincipalExtensions.GetToken(System.Security.Claims.ClaimsPrincipal)">
|
|
<summary>
|
|
Get token from claims.
|
|
</summary>
|
|
<param name="user">Current claims principal.</param>
|
|
<returns>Token.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Extensions.ClaimsPrincipalExtensions.GetIsApiKey(System.Security.Claims.ClaimsPrincipal)">
|
|
<summary>
|
|
Gets a flag specifying whether the request is using an api key.
|
|
</summary>
|
|
<param name="user">Current claims principal.</param>
|
|
<returns>The flag specifying whether the request is using an api key.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Extensions.DtoExtensions">
|
|
<summary>
|
|
Dto Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Extensions.DtoExtensions.AddAdditionalDtoOptions(MediaBrowser.Controller.Dto.DtoOptions,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Collections.Generic.IReadOnlyList{MediaBrowser.Model.Entities.ImageType})">
|
|
<summary>
|
|
Add additional DtoOptions.
|
|
</summary>
|
|
<remarks>
|
|
Converted from IHasDtoOptions.
|
|
Legacy order: 3.
|
|
</remarks>
|
|
<param name="dtoOptions">DtoOptions object.</param>
|
|
<param name="enableImages">Enable images.</param>
|
|
<param name="enableUserData">Enable user data.</param>
|
|
<param name="imageTypeLimit">Image type limit.</param>
|
|
<param name="enableImageTypes">Enable image types.</param>
|
|
<returns>Modified DtoOptions object.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Formatters.CamelCaseJsonProfileFormatter">
|
|
<summary>
|
|
Camel Case Json Profile Formatter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Formatters.CamelCaseJsonProfileFormatter.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Formatters.CamelCaseJsonProfileFormatter"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Formatters.CssOutputFormatter">
|
|
<summary>
|
|
Css output formatter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Formatters.CssOutputFormatter.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Formatters.CssOutputFormatter"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Formatters.PascalCaseJsonProfileFormatter">
|
|
<summary>
|
|
Pascal Case Json Profile Formatter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Formatters.PascalCaseJsonProfileFormatter.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Formatters.PascalCaseJsonProfileFormatter"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Formatters.XmlOutputFormatter">
|
|
<summary>
|
|
Xml output formatter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Formatters.XmlOutputFormatter.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Formatters.XmlOutputFormatter"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Formatters.XmlOutputFormatter.WriteResponseBodyAsync(Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterWriteContext,System.Text.Encoding)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Helpers.AudioHelper">
|
|
<summary>
|
|
Audio helper.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.AudioHelper.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IMediaSourceManager,MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Controller.MediaEncoding.IMediaEncoder,MediaBrowser.Controller.MediaEncoding.ITranscodeManager,System.Net.Http.IHttpClientFactory,Microsoft.AspNetCore.Http.IHttpContextAccessor,MediaBrowser.Controller.MediaEncoding.EncodingHelper)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Helpers.AudioHelper"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="mediaSourceManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IMediaSourceManager"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="mediaEncoder">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.IMediaEncoder"/> interface.</param>
|
|
<param name="transcodeManager">Instance of <see cref="T:MediaBrowser.Controller.MediaEncoding.ITranscodeManager"/> interface.</param>
|
|
<param name="httpClientFactory">Instance of the <see cref="T:System.Net.Http.IHttpClientFactory"/> interface.</param>
|
|
<param name="httpContextAccessor">Instance of the <see cref="T:Microsoft.AspNetCore.Http.IHttpContextAccessor"/> interface.</param>
|
|
<param name="encodingHelper">Instance of <see cref="T:MediaBrowser.Controller.MediaEncoding.EncodingHelper"/>.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.AudioHelper.GetAudioStream(MediaBrowser.Controller.MediaEncoding.TranscodingJobType,MediaBrowser.Controller.Streaming.StreamingRequestDto)">
|
|
<summary>
|
|
Get audio stream.
|
|
</summary>
|
|
<param name="transcodingJobType">Transcoding job type.</param>
|
|
<param name="streamingRequest">Streaming controller.Request dto.</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing the resulting <see cref="T:Microsoft.AspNetCore.Mvc.ActionResult"/>.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Helpers.DynamicHlsHelper">
|
|
<summary>
|
|
Dynamic hls helper.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.#ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.IMediaSourceManager,MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Controller.MediaEncoding.IMediaEncoder,MediaBrowser.Controller.MediaEncoding.ITranscodeManager,MediaBrowser.Common.Net.INetworkManager,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Helpers.DynamicHlsHelper},Microsoft.AspNetCore.Http.IHttpContextAccessor,MediaBrowser.Controller.MediaEncoding.EncodingHelper,MediaBrowser.Controller.Trickplay.ITrickplayManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Helpers.DynamicHlsHelper"/> class.
|
|
</summary>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="mediaSourceManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IMediaSourceManager"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="mediaEncoder">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.IMediaEncoder"/> interface.</param>
|
|
<param name="transcodeManager">Instance of <see cref="T:MediaBrowser.Controller.MediaEncoding.ITranscodeManager"/>.</param>
|
|
<param name="networkManager">Instance of the <see cref="T:MediaBrowser.Common.Net.INetworkManager"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="httpContextAccessor">Instance of the <see cref="T:Microsoft.AspNetCore.Http.IHttpContextAccessor"/> interface.</param>
|
|
<param name="encodingHelper">Instance of <see cref="T:MediaBrowser.Controller.MediaEncoding.EncodingHelper"/>.</param>
|
|
<param name="trickplayManager">Instance of <see cref="T:MediaBrowser.Controller.Trickplay.ITrickplayManager"/>.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.GetMasterHlsPlaylist(MediaBrowser.Controller.MediaEncoding.TranscodingJobType,MediaBrowser.Controller.Streaming.StreamingRequestDto,System.Boolean)">
|
|
<summary>
|
|
Get master hls playlist.
|
|
</summary>
|
|
<param name="transcodingJobType">Transcoding job type.</param>
|
|
<param name="streamingRequest">Streaming request dto.</param>
|
|
<param name="enableAdaptiveBitrateStreaming">Enable adaptive bitrate streaming.</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing the resulting <see cref="T:Microsoft.AspNetCore.Mvc.ActionResult"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylistVideoRangeField(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState)">
|
|
<summary>
|
|
Appends a VIDEO-RANGE field containing the range of the output video stream.
|
|
</summary>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylist(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState,System.String,System.Int32,System.String)"/>
|
|
<param name="builder">StringBuilder to append the field to.</param>
|
|
<param name="state">StreamState of the current stream.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylistCodecsField(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState)">
|
|
<summary>
|
|
Appends a CODECS field containing formatted strings of
|
|
the active streams output video and audio codecs.
|
|
</summary>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylist(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState,System.String,System.Int32,System.String)"/>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.GetPlaylistVideoCodecs(MediaBrowser.Controller.Streaming.StreamState,System.String,System.Int32)"/>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.GetPlaylistAudioCodecs(MediaBrowser.Controller.Streaming.StreamState)"/>
|
|
<param name="builder">StringBuilder to append the field to.</param>
|
|
<param name="state">StreamState of the current stream.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylistSupplementalCodecsField(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState)">
|
|
<summary>
|
|
Appends a SUPPLEMENTAL-CODECS field containing formatted strings of
|
|
the active streams output Dolby Vision Videos.
|
|
</summary>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylist(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState,System.String,System.Int32,System.String)"/>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.GetPlaylistVideoCodecs(MediaBrowser.Controller.Streaming.StreamState,System.String,System.Int32)"/>
|
|
<param name="builder">StringBuilder to append the field to.</param>
|
|
<param name="state">StreamState of the current stream.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylistResolutionField(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState)">
|
|
<summary>
|
|
Appends a RESOLUTION field containing the resolution of the output stream.
|
|
</summary>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylist(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState,System.String,System.Int32,System.String)"/>
|
|
<param name="builder">StringBuilder to append the field to.</param>
|
|
<param name="state">StreamState of the current stream.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylistFramerateField(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState)">
|
|
<summary>
|
|
Appends a FRAME-RATE field containing the framerate of the output stream.
|
|
</summary>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylist(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState,System.String,System.Int32,System.String)"/>
|
|
<param name="builder">StringBuilder to append the field to.</param>
|
|
<param name="state">StreamState of the current stream.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AddTrickplay(MediaBrowser.Controller.Streaming.StreamState,System.Collections.Generic.Dictionary{System.Int32,Jellyfin.Database.Implementations.Entities.TrickplayInfo},System.Text.StringBuilder,System.Security.Claims.ClaimsPrincipal)">
|
|
<summary>
|
|
Appends EXT-X-IMAGE-STREAM-INF playlists for each available trickplay resolution.
|
|
</summary>
|
|
<param name="state">StreamState of the current stream.</param>
|
|
<param name="trickplayResolutions">Dictionary of widths to corresponding tiles info.</param>
|
|
<param name="builder">StringBuilder to append the field to.</param>
|
|
<param name="user">Http user context.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.GetOutputVideoCodecLevel(MediaBrowser.Controller.Streaming.StreamState)">
|
|
<summary>
|
|
Get the H.26X level of the output video stream.
|
|
</summary>
|
|
<param name="state">StreamState of the current stream.</param>
|
|
<returns>H.26X level of the output video stream.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.GetOutputVideoCodecProfile(MediaBrowser.Controller.Streaming.StreamState,System.String)">
|
|
<summary>
|
|
Get the profile of the output video stream.
|
|
</summary>
|
|
<param name="state">StreamState of the current stream.</param>
|
|
<param name="codec">Video codec.</param>
|
|
<returns>Profile of the output video stream.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.GetPlaylistAudioCodecs(MediaBrowser.Controller.Streaming.StreamState)">
|
|
<summary>
|
|
Gets a formatted string of the output audio codec, for use in the CODECS field.
|
|
</summary>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylistCodecsField(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState)"/>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.GetPlaylistVideoCodecs(MediaBrowser.Controller.Streaming.StreamState,System.String,System.Int32)"/>
|
|
<param name="state">StreamState of the current stream.</param>
|
|
<returns>Formatted audio codec string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.DynamicHlsHelper.GetPlaylistVideoCodecs(MediaBrowser.Controller.Streaming.StreamState,System.String,System.Int32)">
|
|
<summary>
|
|
Gets a formatted string of the output video codec, for use in the CODECS field.
|
|
</summary>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.AppendPlaylistCodecsField(System.Text.StringBuilder,MediaBrowser.Controller.Streaming.StreamState)"/>
|
|
<seealso cref="M:Jellyfin.Api.Helpers.DynamicHlsHelper.GetPlaylistAudioCodecs(MediaBrowser.Controller.Streaming.StreamState)"/>
|
|
<param name="state">StreamState of the current stream.</param>
|
|
<param name="codec">Video codec.</param>
|
|
<param name="level">Video level.</param>
|
|
<returns>Formatted video codec string.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Helpers.FileStreamResponseHelpers">
|
|
<summary>
|
|
The stream response helpers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.FileStreamResponseHelpers.GetStaticRemoteStreamResult(MediaBrowser.Controller.Streaming.StreamState,System.Net.Http.HttpClient,Microsoft.AspNetCore.Http.HttpContext,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Returns a static file from a remote source.
|
|
</summary>
|
|
<param name="state">The current <see cref="T:MediaBrowser.Controller.Streaming.StreamState"/>.</param>
|
|
<param name="httpClient">The <see cref="T:System.Net.Http.HttpClient"/> making the remote request.</param>
|
|
<param name="httpContext">The current http context.</param>
|
|
<param name="cancellationToken">A cancellation token that can be used to cancel the operation.</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> containing the API response.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.FileStreamResponseHelpers.GetStaticFileResult(System.String,System.String)">
|
|
<summary>
|
|
Returns a static file from the server.
|
|
</summary>
|
|
<param name="path">The path to the file.</param>
|
|
<param name="contentType">The content type of the file.</param>
|
|
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.ActionResult"/> the file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.FileStreamResponseHelpers.GetTranscodedFile(MediaBrowser.Controller.Streaming.StreamState,System.Boolean,Microsoft.AspNetCore.Http.HttpContext,MediaBrowser.Controller.MediaEncoding.ITranscodeManager,System.String,MediaBrowser.Controller.MediaEncoding.TranscodingJobType,System.Threading.CancellationTokenSource)">
|
|
<summary>
|
|
Returns a transcoded file from the server.
|
|
</summary>
|
|
<param name="state">The current <see cref="T:MediaBrowser.Controller.Streaming.StreamState"/>.</param>
|
|
<param name="isHeadRequest">Whether the current request is a HTTP HEAD request so only the headers get returned.</param>
|
|
<param name="httpContext">The current http context.</param>
|
|
<param name="transcodeManager">The <see cref="T:MediaBrowser.Controller.MediaEncoding.ITranscodeManager"/> singleton.</param>
|
|
<param name="ffmpegCommandLineArguments">The command line arguments to start ffmpeg.</param>
|
|
<param name="transcodingJobType">The <see cref="T:MediaBrowser.Controller.MediaEncoding.TranscodingJobType"/>.</param>
|
|
<param name="cancellationTokenSource">The <see cref="T:System.Threading.CancellationTokenSource"/>.</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> containing the transcoded file.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Helpers.HlsCodecStringHelpers">
|
|
<summary>
|
|
Helpers to generate HLS codec strings according to
|
|
<a href="https://datatracker.ietf.org/doc/html/rfc6381#section-3.3">RFC 6381 section 3.3</a>
|
|
and the <a href="https://mp4ra.org">MP4 Registration Authority</a>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Helpers.HlsCodecStringHelpers.MP3">
|
|
<summary>
|
|
Codec name for MP3.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Helpers.HlsCodecStringHelpers.AC3">
|
|
<summary>
|
|
Codec name for AC-3.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Helpers.HlsCodecStringHelpers.EAC3">
|
|
<summary>
|
|
Codec name for E-AC-3.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Helpers.HlsCodecStringHelpers.FLAC">
|
|
<summary>
|
|
Codec name for FLAC.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Helpers.HlsCodecStringHelpers.ALAC">
|
|
<summary>
|
|
Codec name for ALAC.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Helpers.HlsCodecStringHelpers.OPUS">
|
|
<summary>
|
|
Codec name for OPUS.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.Helpers.HlsCodecStringHelpers.TRUEHD">
|
|
<summary>
|
|
Codec name for TRUEHD.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetMP3String">
|
|
<summary>
|
|
Gets a MP3 codec string.
|
|
</summary>
|
|
<returns>MP3 codec string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetAACString(System.String)">
|
|
<summary>
|
|
Gets an AAC codec string.
|
|
</summary>
|
|
<param name="profile">AAC profile.</param>
|
|
<returns>AAC codec string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetAC3String">
|
|
<summary>
|
|
Gets an AC-3 codec string.
|
|
</summary>
|
|
<returns>AC-3 codec string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetEAC3String">
|
|
<summary>
|
|
Gets an E-AC-3 codec string.
|
|
</summary>
|
|
<returns>E-AC-3 codec string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetFLACString">
|
|
<summary>
|
|
Gets an FLAC codec string.
|
|
</summary>
|
|
<returns>FLAC codec string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetALACString">
|
|
<summary>
|
|
Gets an ALAC codec string.
|
|
</summary>
|
|
<returns>ALAC codec string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetOPUSString">
|
|
<summary>
|
|
Gets an OPUS codec string.
|
|
</summary>
|
|
<returns>OPUS codec string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetTRUEHDString">
|
|
<summary>
|
|
Gets an TRUEHD codec string.
|
|
</summary>
|
|
<returns>TRUEHD codec string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetDTSString(System.String)">
|
|
<summary>
|
|
Gets an DTS codec string.
|
|
</summary>
|
|
<param name="profile">DTS profile.</param>
|
|
<returns>DTS codec string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetH264String(System.String,System.Int32)">
|
|
<summary>
|
|
Gets a H.264 codec string.
|
|
</summary>
|
|
<param name="profile">H.264 profile.</param>
|
|
<param name="level">H.264 level.</param>
|
|
<returns>H.264 string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetH265String(System.String,System.Int32)">
|
|
<summary>
|
|
Gets a H.265 codec string.
|
|
</summary>
|
|
<param name="profile">H.265 profile.</param>
|
|
<param name="level">H.265 level.</param>
|
|
<returns>H.265 string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetVp9String(System.Int32,System.Int32,System.String,System.Single,System.Int32)">
|
|
<summary>
|
|
Gets a VP9 codec string.
|
|
</summary>
|
|
<param name="width">Video width.</param>
|
|
<param name="height">Video height.</param>
|
|
<param name="pixelFormat">Video pixel format.</param>
|
|
<param name="framerate">Video framerate.</param>
|
|
<param name="bitDepth">Video bitDepth.</param>
|
|
<returns>The VP9 codec string.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsCodecStringHelpers.GetAv1String(System.String,System.Int32,System.Boolean,System.Int32)">
|
|
<summary>
|
|
Gets an AV1 codec string.
|
|
</summary>
|
|
<param name="profile">AV1 profile.</param>
|
|
<param name="level">AV1 level.</param>
|
|
<param name="tierFlag">AV1 tier flag.</param>
|
|
<param name="bitDepth">AV1 bit depth.</param>
|
|
<returns>The AV1 codec string.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Helpers.HlsHelpers">
|
|
<summary>
|
|
The hls helpers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsHelpers.WaitForMinimumSegmentCount(System.String,System.Nullable{System.Int32},Microsoft.Extensions.Logging.ILogger,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Waits for a minimum number of segments to be available.
|
|
</summary>
|
|
<param name="playlist">The playlist string.</param>
|
|
<param name="segmentCount">The segment count.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger"/> interface.</param>
|
|
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> indicating the waiting process.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsHelpers.GetFmp4InitFileName(System.String,MediaBrowser.Controller.Streaming.StreamState,System.Boolean)">
|
|
<summary>
|
|
Gets the #EXT-X-MAP string.
|
|
</summary>
|
|
<param name="outputPath">The output path of the file.</param>
|
|
<param name="state">The <see cref="T:MediaBrowser.Controller.Streaming.StreamState"/>.</param>
|
|
<param name="isOsDepends">Get a normal string or depends on OS.</param>
|
|
<returns>The string text of #EXT-X-MAP.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.HlsHelpers.GetLivePlaylistText(System.String,MediaBrowser.Controller.Streaming.StreamState)">
|
|
<summary>
|
|
Gets the hls playlist text.
|
|
</summary>
|
|
<param name="path">The path to the playlist file.</param>
|
|
<param name="state">The <see cref="T:MediaBrowser.Controller.Streaming.StreamState"/>.</param>
|
|
<returns>The playlist text as a string.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Helpers.MediaInfoHelper">
|
|
<summary>
|
|
Media info helper.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.MediaInfoHelper.#ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IMediaSourceManager,MediaBrowser.Controller.MediaEncoding.IMediaEncoder,MediaBrowser.Controller.Configuration.IServerConfigurationManager,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Helpers.MediaInfoHelper},MediaBrowser.Common.Net.INetworkManager,MediaBrowser.Controller.Devices.IDeviceManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Helpers.MediaInfoHelper"/> class.
|
|
</summary>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="mediaSourceManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IMediaSourceManager"/> interface.</param>
|
|
<param name="mediaEncoder">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.IMediaEncoder"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="networkManager">Instance of the <see cref="T:MediaBrowser.Common.Net.INetworkManager"/> interface.</param>
|
|
<param name="deviceManager">Instance of the <see cref="T:MediaBrowser.Controller.Devices.IDeviceManager"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.MediaInfoHelper.GetPlaybackInfo(MediaBrowser.Controller.Entities.BaseItem,Jellyfin.Database.Implementations.Entities.User,System.String,System.String)">
|
|
<summary>
|
|
Get playback info.
|
|
</summary>
|
|
<param name="item">The item.</param>
|
|
<param name="user">The user.</param>
|
|
<param name="mediaSourceId">Media source id.</param>
|
|
<param name="liveStreamId">Live stream id.</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing the <see cref="T:MediaBrowser.Model.MediaInfo.PlaybackInfoResponse"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.MediaInfoHelper.SetDeviceSpecificData(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Dto.MediaSourceInfo,MediaBrowser.Model.Dlna.DeviceProfile,System.Security.Claims.ClaimsPrincipal,System.Nullable{System.Int32},System.Int64,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Guid,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Net.IPAddress)">
|
|
<summary>
|
|
SetDeviceSpecificData.
|
|
</summary>
|
|
<param name="item">Item to set data for.</param>
|
|
<param name="mediaSource">Media source info.</param>
|
|
<param name="profile">Device profile.</param>
|
|
<param name="claimsPrincipal">Current claims principal.</param>
|
|
<param name="maxBitrate">Max bitrate.</param>
|
|
<param name="startTimeTicks">Start time ticks.</param>
|
|
<param name="mediaSourceId">Media source id.</param>
|
|
<param name="audioStreamIndex">Audio stream index.</param>
|
|
<param name="subtitleStreamIndex">Subtitle stream index.</param>
|
|
<param name="maxAudioChannels">Max audio channels.</param>
|
|
<param name="playSessionId">Play session id.</param>
|
|
<param name="userId">User id.</param>
|
|
<param name="enableDirectPlay">Enable direct play.</param>
|
|
<param name="enableDirectStream">Enable direct stream.</param>
|
|
<param name="enableTranscoding">Enable transcoding.</param>
|
|
<param name="allowVideoStreamCopy">Allow video stream copy.</param>
|
|
<param name="allowAudioStreamCopy">Allow audio stream copy.</param>
|
|
<param name="alwaysBurnInSubtitleWhenTranscoding">Always burn-in subtitle when transcoding.</param>
|
|
<param name="ipAddress">Requesting IP address.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.MediaInfoHelper.SortMediaSources(MediaBrowser.Model.MediaInfo.PlaybackInfoResponse,System.Nullable{System.Int64})">
|
|
<summary>
|
|
Sort media source.
|
|
</summary>
|
|
<param name="result">Playback info response.</param>
|
|
<param name="maxBitrate">Max bitrate.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.MediaInfoHelper.OpenMediaSource(Microsoft.AspNetCore.Http.HttpContext,MediaBrowser.Model.MediaInfo.LiveStreamRequest)">
|
|
<summary>
|
|
Open media source.
|
|
</summary>
|
|
<param name="httpContext">Http Context.</param>
|
|
<param name="request">Live stream request.</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing the <see cref="T:MediaBrowser.Model.MediaInfo.LiveStreamResponse"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.MediaInfoHelper.NormalizeMediaSourceContainer(MediaBrowser.Model.Dto.MediaSourceInfo,MediaBrowser.Model.Dlna.DeviceProfile,MediaBrowser.Model.Dlna.DlnaProfileType)">
|
|
<summary>
|
|
Normalize media source container.
|
|
</summary>
|
|
<param name="mediaSource">Media source.</param>
|
|
<param name="profile">Device profile.</param>
|
|
<param name="type">Dlna profile type.</param>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Helpers.RequestHelpers">
|
|
<summary>
|
|
Request Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.RequestHelpers.GetOrderBy(System.Collections.Generic.IReadOnlyList{Jellyfin.Data.Enums.ItemSortBy},System.Collections.Generic.IReadOnlyList{Jellyfin.Database.Implementations.Enums.SortOrder})">
|
|
<summary>
|
|
Get Order By.
|
|
</summary>
|
|
<param name="sortBy">Sort By. Comma delimited string.</param>
|
|
<param name="requestedSortOrder">Sort Order. Comma delimited string.</param>
|
|
<returns>Order By.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.RequestHelpers.GetUserId(System.Security.Claims.ClaimsPrincipal,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Checks if the user can access a user.
|
|
</summary>
|
|
<param name="claimsPrincipal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> for the current request.</param>
|
|
<param name="userId">The user id.</param>
|
|
<returns>A <see cref="T:System.Boolean"/> whether the user can access the user.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.RequestHelpers.AssertCanUpdateUser(System.Security.Claims.ClaimsPrincipal,Jellyfin.Database.Implementations.Entities.User,System.Boolean)">
|
|
<summary>
|
|
Checks if the user can update an entry.
|
|
</summary>
|
|
<param name="claimsPrincipal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> for the current request.</param>
|
|
<param name="user">The user id.</param>
|
|
<param name="restrictUserPreferences">Whether to restrict the user preferences.</param>
|
|
<returns>A <see cref="T:System.Boolean"/> whether the user can update the entry.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.RequestHelpers.GetSession(MediaBrowser.Controller.Session.ISessionManager,MediaBrowser.Controller.Library.IUserManager,Microsoft.AspNetCore.Http.HttpContext,System.Nullable{System.Guid})">
|
|
<summary>
|
|
Get the session based on http request.
|
|
</summary>
|
|
<param name="sessionManager">The session manager.</param>
|
|
<param name="userManager">The user manager.</param>
|
|
<param name="httpContext">The http context.</param>
|
|
<param name="userId">The optional userid.</param>
|
|
<returns>The session.</returns>
|
|
<exception cref="T:MediaBrowser.Common.Extensions.ResourceNotFoundException">Session not found.</exception>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Helpers.StreamingHelpers">
|
|
<summary>
|
|
The streaming helpers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.StreamingHelpers.GetStreamingState(MediaBrowser.Controller.Streaming.StreamingRequestDto,Microsoft.AspNetCore.Http.HttpContext,MediaBrowser.Controller.Library.IMediaSourceManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Controller.MediaEncoding.IMediaEncoder,MediaBrowser.Controller.MediaEncoding.EncodingHelper,MediaBrowser.Controller.MediaEncoding.ITranscodeManager,MediaBrowser.Controller.MediaEncoding.TranscodingJobType,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Gets the current streaming state.
|
|
</summary>
|
|
<param name="streamingRequest">The <see cref="T:MediaBrowser.Controller.Streaming.StreamingRequestDto"/>.</param>
|
|
<param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
|
<param name="mediaSourceManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IMediaSourceManager"/> interface.</param>
|
|
<param name="userManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.IUserManager"/> interface.</param>
|
|
<param name="libraryManager">Instance of the <see cref="T:MediaBrowser.Controller.Library.ILibraryManager"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="mediaEncoder">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.IMediaEncoder"/> interface.</param>
|
|
<param name="encodingHelper">Instance of <see cref="T:MediaBrowser.Controller.MediaEncoding.EncodingHelper"/>.</param>
|
|
<param name="transcodeManager">Instance of the <see cref="T:MediaBrowser.Controller.MediaEncoding.ITranscodeManager"/> interface.</param>
|
|
<param name="transcodingJobType">The <see cref="T:MediaBrowser.Controller.MediaEncoding.TranscodingJobType"/>.</param>
|
|
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> containing the current <see cref="T:MediaBrowser.Controller.Streaming.StreamState"/>.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.StreamingHelpers.ParseStreamOptions(Microsoft.AspNetCore.Http.IQueryCollection)">
|
|
<summary>
|
|
Parses query parameters as StreamOptions.
|
|
</summary>
|
|
<param name="queryString">The query string.</param>
|
|
<returns>A <see cref="T:System.Collections.Generic.Dictionary`2"/> containing the stream options.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.StreamingHelpers.GetOutputFileExtension(MediaBrowser.Controller.Streaming.StreamState,MediaBrowser.Model.Dto.MediaSourceInfo)">
|
|
<summary>
|
|
Gets the output file extension.
|
|
</summary>
|
|
<param name="state">The state.</param>
|
|
<param name="mediaSource">The mediaSource.</param>
|
|
<returns>System.String.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.StreamingHelpers.GetOutputFilePath(MediaBrowser.Controller.Streaming.StreamState,System.String,MediaBrowser.Controller.Configuration.IServerConfigurationManager,System.String,System.String)">
|
|
<summary>
|
|
Gets the output file path for transcoding.
|
|
</summary>
|
|
<param name="state">The current <see cref="T:MediaBrowser.Controller.Streaming.StreamState"/>.</param>
|
|
<param name="outputFileExtension">The file extension of the output file.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="deviceId">The device id.</param>
|
|
<param name="playSessionId">The play session id.</param>
|
|
<returns>The complete file path, including the folder, for the transcoding file.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.StreamingHelpers.ParseParams(MediaBrowser.Controller.Streaming.StreamingRequestDto)">
|
|
<summary>
|
|
Parses the parameters.
|
|
</summary>
|
|
<param name="request">The request.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Helpers.StreamingHelpers.GetContainerFileExtension(System.String)">
|
|
<summary>
|
|
Parses the container into its file extension.
|
|
</summary>
|
|
<param name="container">The container.</param>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Middleware.BaseUrlRedirectionMiddleware">
|
|
<summary>
|
|
Redirect requests without baseurl prefix to the baseurl prefixed URL.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.BaseUrlRedirectionMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Middleware.BaseUrlRedirectionMiddleware},Microsoft.Extensions.Configuration.IConfiguration)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Middleware.BaseUrlRedirectionMiddleware"/> class.
|
|
</summary>
|
|
<param name="next">The next delegate in the pipeline.</param>
|
|
<param name="logger">The logger.</param>
|
|
<param name="configuration">The application configuration.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.BaseUrlRedirectionMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext,MediaBrowser.Controller.Configuration.IServerConfigurationManager)">
|
|
<summary>
|
|
Executes the middleware action.
|
|
</summary>
|
|
<param name="httpContext">The current HTTP context.</param>
|
|
<param name="serverConfigurationManager">The server configuration manager.</param>
|
|
<returns>The async task.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Middleware.ExceptionMiddleware">
|
|
<summary>
|
|
Exception Middleware.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.ExceptionMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Middleware.ExceptionMiddleware},MediaBrowser.Controller.Configuration.IServerConfigurationManager,Microsoft.AspNetCore.Hosting.IWebHostEnvironment)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Middleware.ExceptionMiddleware"/> class.
|
|
</summary>
|
|
<param name="next">Next request delegate.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<param name="hostEnvironment">Instance of the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostEnvironment"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.ExceptionMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext)">
|
|
<summary>
|
|
Invoke request.
|
|
</summary>
|
|
<param name="context">Request context.</param>
|
|
<returns>Task.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Middleware.IPBasedAccessValidationMiddleware">
|
|
<summary>
|
|
Validates the IP of requests coming from local networks wrt. remote access.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.IPBasedAccessValidationMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Middleware.IPBasedAccessValidationMiddleware})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Middleware.IPBasedAccessValidationMiddleware"/> class.
|
|
</summary>
|
|
<param name="next">The next delegate in the pipeline.</param>
|
|
<param name="logger">The logger to log to.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.IPBasedAccessValidationMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext,MediaBrowser.Common.Net.INetworkManager)">
|
|
<summary>
|
|
Executes the middleware action.
|
|
</summary>
|
|
<param name="httpContext">The current HTTP context.</param>
|
|
<param name="networkManager">The network manager.</param>
|
|
<returns>The async task.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Middleware.QueryStringDecodingMiddleware">
|
|
<summary>
|
|
URL decodes the querystring before binding.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.QueryStringDecodingMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Middleware.QueryStringDecodingMiddleware"/> class.
|
|
</summary>
|
|
<param name="next">The next delegate in the pipeline.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.QueryStringDecodingMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext)">
|
|
<summary>
|
|
Executes the middleware action.
|
|
</summary>
|
|
<param name="httpContext">The current HTTP context.</param>
|
|
<returns>The async task.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Middleware.ResponseTimeMiddleware">
|
|
<summary>
|
|
Response time middleware.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.ResponseTimeMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Middleware.ResponseTimeMiddleware})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Middleware.ResponseTimeMiddleware"/> class.
|
|
</summary>
|
|
<param name="next">Next request delegate.</param>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.ResponseTimeMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext,MediaBrowser.Controller.Configuration.IServerConfigurationManager)">
|
|
<summary>
|
|
Invoke request.
|
|
</summary>
|
|
<param name="context">Request context.</param>
|
|
<param name="serverConfigurationManager">Instance of the <see cref="T:MediaBrowser.Controller.Configuration.IServerConfigurationManager"/> interface.</param>
|
|
<returns>Task.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Middleware.RobotsRedirectionMiddleware">
|
|
<summary>
|
|
Redirect requests to robots.txt to web/robots.txt.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.RobotsRedirectionMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Middleware.RobotsRedirectionMiddleware})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Middleware.RobotsRedirectionMiddleware"/> class.
|
|
</summary>
|
|
<param name="next">The next delegate in the pipeline.</param>
|
|
<param name="logger">The logger.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.RobotsRedirectionMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext)">
|
|
<summary>
|
|
Executes the middleware action.
|
|
</summary>
|
|
<param name="httpContext">The current HTTP context.</param>
|
|
<returns>The async task.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Middleware.ServerStartupMessageMiddleware">
|
|
<summary>
|
|
Shows a custom message during server startup.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.ServerStartupMessageMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Middleware.ServerStartupMessageMiddleware"/> class.
|
|
</summary>
|
|
<param name="next">The next delegate in the pipeline.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.ServerStartupMessageMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext,MediaBrowser.Controller.IServerApplicationHost,MediaBrowser.Model.Globalization.ILocalizationManager)">
|
|
<summary>
|
|
Executes the middleware action.
|
|
</summary>
|
|
<param name="httpContext">The current HTTP context.</param>
|
|
<param name="serverApplicationHost">The server application host.</param>
|
|
<param name="localizationManager">The localization manager.</param>
|
|
<returns>The async task.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Middleware.UrlDecodeQueryFeature">
|
|
<summary>
|
|
Defines the <see cref="T:Jellyfin.Api.Middleware.UrlDecodeQueryFeature"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.UrlDecodeQueryFeature.#ctor(Microsoft.AspNetCore.Http.Features.IQueryFeature)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Middleware.UrlDecodeQueryFeature"/> class.
|
|
</summary>
|
|
<param name="feature">The <see cref="T:Microsoft.AspNetCore.Http.Features.IQueryFeature"/> instance.</param>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Middleware.UrlDecodeQueryFeature.Query">
|
|
<summary>
|
|
Gets or sets a value indicating the url decoded <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Middleware.WebSocketAuthenticationMiddleware">
|
|
<summary>
|
|
WebSocket Authentication Middleware.
|
|
Extracts and validates API tokens from WebSocket query strings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.WebSocketAuthenticationMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.Middleware.WebSocketAuthenticationMiddleware})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Middleware.WebSocketAuthenticationMiddleware"/> class.
|
|
</summary>
|
|
<param name="next">The next delegate in the pipeline.</param>
|
|
<param name="logger">The logger.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.WebSocketAuthenticationMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext,MediaBrowser.Controller.Net.IAuthService)">
|
|
<summary>
|
|
Executes the middleware action.
|
|
</summary>
|
|
<param name="httpContext">The current HTTP context.</param>
|
|
<param name="authService">The authentication service.</param>
|
|
<returns>The async task.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.WebSocketAuthenticationMiddleware.AuthenticateWebSocketRequest(Microsoft.AspNetCore.Http.HttpContext,MediaBrowser.Controller.Net.IAuthService)">
|
|
<summary>
|
|
Authenticates WebSocket requests by extracting api_key from query string.
|
|
</summary>
|
|
<param name="httpContext">The HTTP context.</param>
|
|
<param name="authService">The authentication service.</param>
|
|
<returns>The async task.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Middleware.WebSocketAuthenticationMiddlewareExtensions">
|
|
<summary>
|
|
Extension methods for adding WebSocket authentication to the pipeline.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.WebSocketAuthenticationMiddlewareExtensions.UseWebSocketAuthentication(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
|
|
<summary>
|
|
Adds WebSocket authentication to the application pipeline.
|
|
</summary>
|
|
<param name="appBuilder">The application builder.</param>
|
|
<returns>The updated application builder.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Middleware.WebSocketHandlerMiddleware">
|
|
<summary>
|
|
Handles WebSocket requests.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.WebSocketHandlerMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Middleware.WebSocketHandlerMiddleware"/> class.
|
|
</summary>
|
|
<param name="next">The next delegate in the pipeline.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Middleware.WebSocketHandlerMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext,MediaBrowser.Controller.Net.IWebSocketManager)">
|
|
<summary>
|
|
Executes the middleware action.
|
|
</summary>
|
|
<param name="httpContext">The current HTTP context.</param>
|
|
<param name="webSocketManager">The WebSocket connection manager.</param>
|
|
<returns>The async task.</returns>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.ModelBinders.CommaDelimitedCollectionModelBinder">
|
|
<summary>
|
|
Comma delimited collection model binder.
|
|
Returns an empty array of specified type if there is no query parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.ModelBinders.CommaDelimitedCollectionModelBinder.#ctor(Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.ModelBinders.CommaDelimitedCollectionModelBinder})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.ModelBinders.CommaDelimitedCollectionModelBinder"/> class.
|
|
</summary>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.ModelBinders.CommaDelimitedCollectionModelBinder.BindModelAsync(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.ModelBinders.LegacyDateTimeModelBinder">
|
|
<summary>
|
|
DateTime model binder.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.ModelBinders.LegacyDateTimeModelBinder.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.ModelBinders.LegacyDateTimeModelBinder"/> class.
|
|
</summary>
|
|
<param name="loggerFactory">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.ModelBinders.LegacyDateTimeModelBinder.BindModelAsync(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.ModelBinders.NullableEnumModelBinder">
|
|
<summary>
|
|
Nullable enum model binder.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.ModelBinders.NullableEnumModelBinder.#ctor(Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.ModelBinders.NullableEnumModelBinder})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.ModelBinders.NullableEnumModelBinder"/> class.
|
|
</summary>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.ModelBinders.NullableEnumModelBinder.BindModelAsync(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.ModelBinders.NullableEnumModelBinderProvider">
|
|
<summary>
|
|
Nullable enum model binder provider.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.ModelBinders.NullableEnumModelBinderProvider.GetBinder(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.ModelBinders.PipeDelimitedCollectionModelBinder">
|
|
<summary>
|
|
Comma delimited collection model binder.
|
|
Returns an empty collection of specified type if there is no query parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.ModelBinders.PipeDelimitedCollectionModelBinder.#ctor(Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.ModelBinders.PipeDelimitedCollectionModelBinder})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.ModelBinders.PipeDelimitedCollectionModelBinder"/> class.
|
|
</summary>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.ModelBinders.PipeDelimitedCollectionModelBinder.BindModelAsync(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.ClientLogDtos.ClientLogDocumentResponseDto">
|
|
<summary>
|
|
Client log document response dto.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.ClientLogDtos.ClientLogDocumentResponseDto.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.ClientLogDtos.ClientLogDocumentResponseDto"/> class.
|
|
</summary>
|
|
<param name="fileName">The file name.</param>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.ClientLogDtos.ClientLogDocumentResponseDto.FileName">
|
|
<summary>
|
|
Gets the resulting filename.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.ConfigurationPageInfo">
|
|
<summary>
|
|
The configuration page info.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.ConfigurationPageInfo.#ctor(MediaBrowser.Common.Plugins.IPlugin,MediaBrowser.Model.Plugins.PluginPageInfo)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.ConfigurationPageInfo"/> class.
|
|
</summary>
|
|
<param name="plugin">Instance of <see cref="T:MediaBrowser.Common.Plugins.IPlugin"/> interface.</param>
|
|
<param name="page">Instance of <see cref="T:MediaBrowser.Model.Plugins.PluginPageInfo"/> interface.</param>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.ConfigurationPageInfo.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.ConfigurationPageInfo"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.ConfigurationPageInfo.Name">
|
|
<summary>
|
|
Gets or sets the name.
|
|
</summary>
|
|
<value>The name.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.ConfigurationPageInfo.EnableInMainMenu">
|
|
<summary>
|
|
Gets or sets a value indicating whether the configurations page is enabled in the main menu.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.ConfigurationPageInfo.MenuSection">
|
|
<summary>
|
|
Gets or sets the menu section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.ConfigurationPageInfo.MenuIcon">
|
|
<summary>
|
|
Gets or sets the menu icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.ConfigurationPageInfo.DisplayName">
|
|
<summary>
|
|
Gets or sets the display name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.ConfigurationPageInfo.PluginId">
|
|
<summary>
|
|
Gets or sets the plugin id.
|
|
</summary>
|
|
<value>The plugin id.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.EnvironmentDtos.DefaultDirectoryBrowserInfoDto">
|
|
<summary>
|
|
Default directory browser info.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.EnvironmentDtos.DefaultDirectoryBrowserInfoDto.Path">
|
|
<summary>
|
|
Gets or sets the path.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.EnvironmentDtos.ValidatePathDto">
|
|
<summary>
|
|
Validate path object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.EnvironmentDtos.ValidatePathDto.ValidateWritable">
|
|
<summary>
|
|
Gets or sets a value indicating whether validate if path is writable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.EnvironmentDtos.ValidatePathDto.Path">
|
|
<summary>
|
|
Gets or sets the path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.EnvironmentDtos.ValidatePathDto.IsFile">
|
|
<summary>
|
|
Gets or sets is path file.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.LibraryDtos.LibraryOptionInfoDto">
|
|
<summary>
|
|
Library option info dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryOptionInfoDto.Name">
|
|
<summary>
|
|
Gets or sets name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryOptionInfoDto.DefaultEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether default enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.LibraryDtos.LibraryOptionsResultDto">
|
|
<summary>
|
|
Library options result dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryOptionsResultDto.MetadataSavers">
|
|
<summary>
|
|
Gets or sets the metadata savers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryOptionsResultDto.MetadataReaders">
|
|
<summary>
|
|
Gets or sets the metadata readers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryOptionsResultDto.SubtitleFetchers">
|
|
<summary>
|
|
Gets or sets the subtitle fetchers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryOptionsResultDto.LyricFetchers">
|
|
<summary>
|
|
Gets or sets the list of lyric fetchers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryOptionsResultDto.MediaSegmentProviders">
|
|
<summary>
|
|
Gets or sets the list of MediaSegment Providers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryOptionsResultDto.TypeOptions">
|
|
<summary>
|
|
Gets or sets the type options.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.LibraryDtos.LibraryTypeOptionsDto">
|
|
<summary>
|
|
Library type options dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryTypeOptionsDto.Type">
|
|
<summary>
|
|
Gets or sets the type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryTypeOptionsDto.MetadataFetchers">
|
|
<summary>
|
|
Gets or sets the metadata fetchers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryTypeOptionsDto.ImageFetchers">
|
|
<summary>
|
|
Gets or sets the image fetchers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryTypeOptionsDto.SupportedImageTypes">
|
|
<summary>
|
|
Gets or sets the supported image types.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.LibraryTypeOptionsDto.DefaultImageOptions">
|
|
<summary>
|
|
Gets or sets the default image options.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.LibraryDtos.MediaUpdateInfoDto">
|
|
<summary>
|
|
Media Update Info Dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.MediaUpdateInfoDto.Updates">
|
|
<summary>
|
|
Gets or sets the list of updates.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.LibraryDtos.MediaUpdateInfoPathDto">
|
|
<summary>
|
|
The media update info path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.MediaUpdateInfoPathDto.Path">
|
|
<summary>
|
|
Gets or sets media path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryDtos.MediaUpdateInfoPathDto.UpdateType">
|
|
<summary>
|
|
Gets or sets media update type.
|
|
Created, Modified, Deleted.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.LibraryStructureDto.AddVirtualFolderDto">
|
|
<summary>
|
|
Add virtual folder dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryStructureDto.AddVirtualFolderDto.LibraryOptions">
|
|
<summary>
|
|
Gets or sets library options.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.LibraryStructureDto.MediaPathDto">
|
|
<summary>
|
|
Media Path dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryStructureDto.MediaPathDto.Name">
|
|
<summary>
|
|
Gets or sets the name of the library.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryStructureDto.MediaPathDto.Path">
|
|
<summary>
|
|
Gets or sets the path to add.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryStructureDto.MediaPathDto.PathInfo">
|
|
<summary>
|
|
Gets or sets the path info.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.LibraryStructureDto.UpdateLibraryOptionsDto">
|
|
<summary>
|
|
Update library options dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryStructureDto.UpdateLibraryOptionsDto.Id">
|
|
<summary>
|
|
Gets or sets the library item id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryStructureDto.UpdateLibraryOptionsDto.LibraryOptions">
|
|
<summary>
|
|
Gets or sets library options.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.LibraryStructureDto.UpdateMediaPathRequestDto">
|
|
<summary>
|
|
Update library options dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryStructureDto.UpdateMediaPathRequestDto.Name">
|
|
<summary>
|
|
Gets or sets the library name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LibraryStructureDto.UpdateMediaPathRequestDto.PathInfo">
|
|
<summary>
|
|
Gets or sets library folder path information.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto">
|
|
<summary>
|
|
Get programs dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.ChannelIds">
|
|
<summary>
|
|
Gets or sets the channels to return guide information for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.UserId">
|
|
<summary>
|
|
Gets or sets optional. Filter by user id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.MinStartDate">
|
|
<summary>
|
|
Gets or sets the minimum premiere start date.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.HasAired">
|
|
<summary>
|
|
Gets or sets filter by programs that have completed airing, or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.IsAiring">
|
|
<summary>
|
|
Gets or sets filter by programs that are currently airing, or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.MaxStartDate">
|
|
<summary>
|
|
Gets or sets the maximum premiere start date.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.MinEndDate">
|
|
<summary>
|
|
Gets or sets the minimum premiere end date.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.MaxEndDate">
|
|
<summary>
|
|
Gets or sets the maximum premiere end date.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.IsMovie">
|
|
<summary>
|
|
Gets or sets filter for movies.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.IsSeries">
|
|
<summary>
|
|
Gets or sets filter for series.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.IsNews">
|
|
<summary>
|
|
Gets or sets filter for news.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.IsKids">
|
|
<summary>
|
|
Gets or sets filter for kids.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.IsSports">
|
|
<summary>
|
|
Gets or sets filter for sports.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.StartIndex">
|
|
<summary>
|
|
Gets or sets the record index to start at. All items with a lower index will be dropped from the results.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.Limit">
|
|
<summary>
|
|
Gets or sets the maximum number of records to return.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.SortBy">
|
|
<summary>
|
|
Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.SortOrder">
|
|
<summary>
|
|
Gets or sets sort order.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.Genres">
|
|
<summary>
|
|
Gets or sets the genres to return guide information for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.GenreIds">
|
|
<summary>
|
|
Gets or sets the genre ids to return guide information for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.EnableImages">
|
|
<summary>
|
|
Gets or sets include image information in output.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.EnableTotalRecordCount">
|
|
<summary>
|
|
Gets or sets a value indicating whether retrieve total record count.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.ImageTypeLimit">
|
|
<summary>
|
|
Gets or sets the max number of images to return, per image type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.EnableImageTypes">
|
|
<summary>
|
|
Gets or sets the image types to include in the output.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.EnableUserData">
|
|
<summary>
|
|
Gets or sets include user data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.SeriesTimerId">
|
|
<summary>
|
|
Gets or sets filter by series timer id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.LibrarySeriesId">
|
|
<summary>
|
|
Gets or sets filter by library series id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.GetProgramsDto.Fields">
|
|
<summary>
|
|
Gets or sets specify additional fields of information to return in the output.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.LiveTvDtos.SetChannelMappingDto">
|
|
<summary>
|
|
Set channel mapping dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.SetChannelMappingDto.ProviderId">
|
|
<summary>
|
|
Gets or sets the provider id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.SetChannelMappingDto.TunerChannelId">
|
|
<summary>
|
|
Gets or sets the tuner channel id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.LiveTvDtos.SetChannelMappingDto.ProviderChannelId">
|
|
<summary>
|
|
Gets or sets the provider channel id.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto">
|
|
<summary>
|
|
Open live stream dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.OpenToken">
|
|
<summary>
|
|
Gets or sets the open token.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.UserId">
|
|
<summary>
|
|
Gets or sets the user id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.PlaySessionId">
|
|
<summary>
|
|
Gets or sets the play session id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.MaxStreamingBitrate">
|
|
<summary>
|
|
Gets or sets the max streaming bitrate.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.StartTimeTicks">
|
|
<summary>
|
|
Gets or sets the start time in ticks.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.AudioStreamIndex">
|
|
<summary>
|
|
Gets or sets the audio stream index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.SubtitleStreamIndex">
|
|
<summary>
|
|
Gets or sets the subtitle stream index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.MaxAudioChannels">
|
|
<summary>
|
|
Gets or sets the max audio channels.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.ItemId">
|
|
<summary>
|
|
Gets or sets the item id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.EnableDirectPlay">
|
|
<summary>
|
|
Gets or sets a value indicating whether to enable direct play.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.EnableDirectStream">
|
|
<summary>
|
|
Gets or sets a value indicating whether to enable direct stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.AlwaysBurnInSubtitleWhenTranscoding">
|
|
<summary>
|
|
Gets or sets a value indicating whether always burn in subtitles when transcoding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.DeviceProfile">
|
|
<summary>
|
|
Gets or sets the device profile.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.OpenLiveStreamDto.DirectPlayProtocols">
|
|
<summary>
|
|
Gets or sets the device play protocols.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto">
|
|
<summary>
|
|
Playback info dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.UserId">
|
|
<summary>
|
|
Gets or sets the playback userId.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.MaxStreamingBitrate">
|
|
<summary>
|
|
Gets or sets the max streaming bitrate.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.StartTimeTicks">
|
|
<summary>
|
|
Gets or sets the start time in ticks.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.AudioStreamIndex">
|
|
<summary>
|
|
Gets or sets the audio stream index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.SubtitleStreamIndex">
|
|
<summary>
|
|
Gets or sets the subtitle stream index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.MaxAudioChannels">
|
|
<summary>
|
|
Gets or sets the max audio channels.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.MediaSourceId">
|
|
<summary>
|
|
Gets or sets the media source id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.LiveStreamId">
|
|
<summary>
|
|
Gets or sets the live stream id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.DeviceProfile">
|
|
<summary>
|
|
Gets or sets the device profile.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.EnableDirectPlay">
|
|
<summary>
|
|
Gets or sets a value indicating whether to enable direct play.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.EnableDirectStream">
|
|
<summary>
|
|
Gets or sets a value indicating whether to enable direct stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.EnableTranscoding">
|
|
<summary>
|
|
Gets or sets a value indicating whether to enable transcoding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.AllowVideoStreamCopy">
|
|
<summary>
|
|
Gets or sets a value indicating whether to enable video stream copy.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.AllowAudioStreamCopy">
|
|
<summary>
|
|
Gets or sets a value indicating whether to allow audio stream copy.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.AutoOpenLiveStream">
|
|
<summary>
|
|
Gets or sets a value indicating whether to auto open the live stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.MediaInfoDtos.PlaybackInfoDto.AlwaysBurnInSubtitleWhenTranscoding">
|
|
<summary>
|
|
Gets or sets a value indicating whether always burn in subtitles when transcoding.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.PlaylistDtos.CreatePlaylistDto">
|
|
<summary>
|
|
Create new playlist dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.PlaylistDtos.CreatePlaylistDto.Name">
|
|
<summary>
|
|
Gets or sets the name of the new playlist.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.PlaylistDtos.CreatePlaylistDto.Ids">
|
|
<summary>
|
|
Gets or sets item ids to add to the playlist.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.PlaylistDtos.CreatePlaylistDto.UserId">
|
|
<summary>
|
|
Gets or sets the user id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.PlaylistDtos.CreatePlaylistDto.MediaType">
|
|
<summary>
|
|
Gets or sets the media type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.PlaylistDtos.CreatePlaylistDto.Users">
|
|
<summary>
|
|
Gets or sets the playlist users.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.PlaylistDtos.CreatePlaylistDto.IsPublic">
|
|
<summary>
|
|
Gets or sets a value indicating whether the playlist is public.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto">
|
|
<summary>
|
|
Update existing playlist dto. Fields set to `null` will not be updated and keep their current values.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto.Name">
|
|
<summary>
|
|
Gets or sets the name of the new playlist.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto.Ids">
|
|
<summary>
|
|
Gets or sets item ids of the playlist.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto.Users">
|
|
<summary>
|
|
Gets or sets the playlist users.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto.IsPublic">
|
|
<summary>
|
|
Gets or sets a value indicating whether the playlist is public.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto">
|
|
<summary>
|
|
Update existing playlist user dto. Fields set to `null` will not be updated and keep their current values.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto.CanEdit">
|
|
<summary>
|
|
Gets or sets a value indicating whether the user can edit the playlist.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.StartupDtos.StartupConfigurationDto">
|
|
<summary>
|
|
The startup configuration DTO.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.StartupDtos.StartupConfigurationDto.ServerName">
|
|
<summary>
|
|
Gets or sets the server name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.StartupDtos.StartupConfigurationDto.UICulture">
|
|
<summary>
|
|
Gets or sets UI language culture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.StartupDtos.StartupConfigurationDto.MetadataCountryCode">
|
|
<summary>
|
|
Gets or sets the metadata country code.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.StartupDtos.StartupConfigurationDto.PreferredMetadataLanguage">
|
|
<summary>
|
|
Gets or sets the preferred language for the metadata.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.StartupDtos.StartupRemoteAccessDto">
|
|
<summary>
|
|
Startup remote access dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.StartupDtos.StartupRemoteAccessDto.EnableRemoteAccess">
|
|
<summary>
|
|
Gets or sets a value indicating whether enable remote access.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.StartupDtos.StartupUserDto">
|
|
<summary>
|
|
The startup user DTO.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.StartupDtos.StartupUserDto.Name">
|
|
<summary>
|
|
Gets or sets the username.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.StartupDtos.StartupUserDto.Password">
|
|
<summary>
|
|
Gets or sets the user's password.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.StreamingDtos.HlsAudioRequestDto">
|
|
<summary>
|
|
The hls video request dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.StreamingDtos.HlsAudioRequestDto.EnableAdaptiveBitrateStreaming">
|
|
<summary>
|
|
Gets or sets a value indicating whether enable adaptive bitrate streaming.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.StreamingDtos.HlsVideoRequestDto">
|
|
<summary>
|
|
The hls video request dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.StreamingDtos.HlsVideoRequestDto.EnableAdaptiveBitrateStreaming">
|
|
<summary>
|
|
Gets or sets a value indicating whether enable adaptive bitrate streaming.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SubtitleDtos.UploadSubtitleDto">
|
|
<summary>
|
|
Upload subtitles dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SubtitleDtos.UploadSubtitleDto.Language">
|
|
<summary>
|
|
Gets or sets the subtitle language.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SubtitleDtos.UploadSubtitleDto.Format">
|
|
<summary>
|
|
Gets or sets the subtitle format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SubtitleDtos.UploadSubtitleDto.IsForced">
|
|
<summary>
|
|
Gets or sets a value indicating whether the subtitle is forced.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SubtitleDtos.UploadSubtitleDto.IsHearingImpaired">
|
|
<summary>
|
|
Gets or sets a value indicating whether the subtitle is for hearing impaired.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SubtitleDtos.UploadSubtitleDto.Data">
|
|
<summary>
|
|
Gets or sets the subtitle data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.BufferRequestDto">
|
|
<summary>
|
|
Class BufferRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.SyncPlayDtos.BufferRequestDto.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.SyncPlayDtos.BufferRequestDto"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.BufferRequestDto.When">
|
|
<summary>
|
|
Gets or sets when the request has been made by the client.
|
|
</summary>
|
|
<value>The date of the request.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.BufferRequestDto.PositionTicks">
|
|
<summary>
|
|
Gets or sets the position ticks.
|
|
</summary>
|
|
<value>The position ticks.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.BufferRequestDto.IsPlaying">
|
|
<summary>
|
|
Gets or sets a value indicating whether the client playback is unpaused.
|
|
</summary>
|
|
<value>The client playback status.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.BufferRequestDto.PlaylistItemId">
|
|
<summary>
|
|
Gets or sets the playlist item identifier of the playing item.
|
|
</summary>
|
|
<value>The playlist item identifier.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.IgnoreWaitRequestDto">
|
|
<summary>
|
|
Class IgnoreWaitRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.IgnoreWaitRequestDto.IgnoreWait">
|
|
<summary>
|
|
Gets or sets a value indicating whether the client should be ignored.
|
|
</summary>
|
|
<value>The client group-wait status.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.JoinGroupRequestDto">
|
|
<summary>
|
|
Class JoinGroupRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.JoinGroupRequestDto.GroupId">
|
|
<summary>
|
|
Gets or sets the group identifier.
|
|
</summary>
|
|
<value>The identifier of the group to join.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.MovePlaylistItemRequestDto">
|
|
<summary>
|
|
Class MovePlaylistItemRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.SyncPlayDtos.MovePlaylistItemRequestDto.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.SyncPlayDtos.MovePlaylistItemRequestDto"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.MovePlaylistItemRequestDto.PlaylistItemId">
|
|
<summary>
|
|
Gets or sets the playlist identifier of the item.
|
|
</summary>
|
|
<value>The playlist identifier of the item.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.MovePlaylistItemRequestDto.NewIndex">
|
|
<summary>
|
|
Gets or sets the new position.
|
|
</summary>
|
|
<value>The new position.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.NewGroupRequestDto">
|
|
<summary>
|
|
Class NewGroupRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.SyncPlayDtos.NewGroupRequestDto.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.SyncPlayDtos.NewGroupRequestDto"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.NewGroupRequestDto.GroupName">
|
|
<summary>
|
|
Gets or sets the group name.
|
|
</summary>
|
|
<value>The name of the new group.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.NextItemRequestDto">
|
|
<summary>
|
|
Class NextItemRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.SyncPlayDtos.NextItemRequestDto.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.SyncPlayDtos.NextItemRequestDto"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.NextItemRequestDto.PlaylistItemId">
|
|
<summary>
|
|
Gets or sets the playing item identifier.
|
|
</summary>
|
|
<value>The playing item identifier.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.PingRequestDto">
|
|
<summary>
|
|
Class PingRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.PingRequestDto.Ping">
|
|
<summary>
|
|
Gets or sets the ping time.
|
|
</summary>
|
|
<value>The ping time.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.PlayRequestDto">
|
|
<summary>
|
|
Class PlayRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.SyncPlayDtos.PlayRequestDto.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.SyncPlayDtos.PlayRequestDto"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.PlayRequestDto.PlayingQueue">
|
|
<summary>
|
|
Gets or sets the playing queue.
|
|
</summary>
|
|
<value>The playing queue.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.PlayRequestDto.PlayingItemPosition">
|
|
<summary>
|
|
Gets or sets the position of the playing item in the queue.
|
|
</summary>
|
|
<value>The playing item position.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.PlayRequestDto.StartPositionTicks">
|
|
<summary>
|
|
Gets or sets the start position ticks.
|
|
</summary>
|
|
<value>The start position ticks.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.PreviousItemRequestDto">
|
|
<summary>
|
|
Class PreviousItemRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.SyncPlayDtos.PreviousItemRequestDto.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.SyncPlayDtos.PreviousItemRequestDto"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.PreviousItemRequestDto.PlaylistItemId">
|
|
<summary>
|
|
Gets or sets the playing item identifier.
|
|
</summary>
|
|
<value>The playing item identifier.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.QueueRequestDto">
|
|
<summary>
|
|
Class QueueRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.SyncPlayDtos.QueueRequestDto.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.SyncPlayDtos.QueueRequestDto"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.QueueRequestDto.ItemIds">
|
|
<summary>
|
|
Gets or sets the items to enqueue.
|
|
</summary>
|
|
<value>The items to enqueue.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.QueueRequestDto.Mode">
|
|
<summary>
|
|
Gets or sets the mode in which to add the new items.
|
|
</summary>
|
|
<value>The enqueue mode.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.ReadyRequestDto">
|
|
<summary>
|
|
Class ReadyRequest.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.SyncPlayDtos.ReadyRequestDto.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.SyncPlayDtos.ReadyRequestDto"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.ReadyRequestDto.When">
|
|
<summary>
|
|
Gets or sets when the request has been made by the client.
|
|
</summary>
|
|
<value>The date of the request.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.ReadyRequestDto.PositionTicks">
|
|
<summary>
|
|
Gets or sets the position ticks.
|
|
</summary>
|
|
<value>The position ticks.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.ReadyRequestDto.IsPlaying">
|
|
<summary>
|
|
Gets or sets a value indicating whether the client playback is unpaused.
|
|
</summary>
|
|
<value>The client playback status.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.ReadyRequestDto.PlaylistItemId">
|
|
<summary>
|
|
Gets or sets the playlist item identifier of the playing item.
|
|
</summary>
|
|
<value>The playlist item identifier.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.RemoveFromPlaylistRequestDto">
|
|
<summary>
|
|
Class RemoveFromPlaylistRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.SyncPlayDtos.RemoveFromPlaylistRequestDto.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.SyncPlayDtos.RemoveFromPlaylistRequestDto"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.RemoveFromPlaylistRequestDto.PlaylistItemIds">
|
|
<summary>
|
|
Gets or sets the playlist identifiers of the items. Ignored when clearing the playlist.
|
|
</summary>
|
|
<value>The playlist identifiers of the items.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.RemoveFromPlaylistRequestDto.ClearPlaylist">
|
|
<summary>
|
|
Gets or sets a value indicating whether the entire playlist should be cleared.
|
|
</summary>
|
|
<value>Whether the entire playlist should be cleared.</value>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.RemoveFromPlaylistRequestDto.ClearPlayingItem">
|
|
<summary>
|
|
Gets or sets a value indicating whether the playing item should be removed as well. Used only when clearing the playlist.
|
|
</summary>
|
|
<value>Whether the playing item should be removed as well.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.SeekRequestDto">
|
|
<summary>
|
|
Class SeekRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.SeekRequestDto.PositionTicks">
|
|
<summary>
|
|
Gets or sets the position ticks.
|
|
</summary>
|
|
<value>The position ticks.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.SetPlaylistItemRequestDto">
|
|
<summary>
|
|
Class SetPlaylistItemRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Models.SyncPlayDtos.SetPlaylistItemRequestDto.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Models.SyncPlayDtos.SetPlaylistItemRequestDto"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.SetPlaylistItemRequestDto.PlaylistItemId">
|
|
<summary>
|
|
Gets or sets the playlist identifier of the playing item.
|
|
</summary>
|
|
<value>The playlist identifier of the playing item.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.SetRepeatModeRequestDto">
|
|
<summary>
|
|
Class SetRepeatModeRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.SetRepeatModeRequestDto.Mode">
|
|
<summary>
|
|
Gets or sets the repeat mode.
|
|
</summary>
|
|
<value>The repeat mode.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SyncPlayDtos.SetShuffleModeRequestDto">
|
|
<summary>
|
|
Class SetShuffleModeRequestDto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SyncPlayDtos.SetShuffleModeRequestDto.Mode">
|
|
<summary>
|
|
Gets or sets the shuffle mode.
|
|
</summary>
|
|
<value>The shuffle mode.</value>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SystemInfoDtos.FolderStorageDto">
|
|
<summary>
|
|
Contains information about a specific folder.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.FolderStorageDto.Path">
|
|
<summary>
|
|
Gets the path of the folder in question.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.FolderStorageDto.FreeSpace">
|
|
<summary>
|
|
Gets the free space of the underlying storage device of the <see cref="P:Jellyfin.Api.Models.SystemInfoDtos.FolderStorageDto.Path"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.FolderStorageDto.UsedSpace">
|
|
<summary>
|
|
Gets the used space of the underlying storage device of the <see cref="P:Jellyfin.Api.Models.SystemInfoDtos.FolderStorageDto.Path"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.FolderStorageDto.StorageType">
|
|
<summary>
|
|
Gets the kind of storage device of the <see cref="P:Jellyfin.Api.Models.SystemInfoDtos.FolderStorageDto.Path"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.FolderStorageDto.DeviceId">
|
|
<summary>
|
|
Gets the Device Identifier.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SystemInfoDtos.LibraryStorageDto">
|
|
<summary>
|
|
Contains informations about a libraries storage informations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.LibraryStorageDto.Id">
|
|
<summary>
|
|
Gets or sets the Library Id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.LibraryStorageDto.Name">
|
|
<summary>
|
|
Gets or sets the name of the library.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.LibraryStorageDto.Folders">
|
|
<summary>
|
|
Gets or sets the storage informations about the folders used in a library.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.SystemInfoDtos.SystemStorageDto">
|
|
<summary>
|
|
Contains informations about the systems storage.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.SystemStorageDto.ProgramDataFolder">
|
|
<summary>
|
|
Gets or sets the Storage information of the program data folder.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.SystemStorageDto.WebFolder">
|
|
<summary>
|
|
Gets or sets the Storage information of the web UI resources folder.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.SystemStorageDto.ImageCacheFolder">
|
|
<summary>
|
|
Gets or sets the Storage information of the folder where images are cached.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.SystemStorageDto.CacheFolder">
|
|
<summary>
|
|
Gets or sets the Storage information of the cache folder.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.SystemStorageDto.LogFolder">
|
|
<summary>
|
|
Gets or sets the Storage information of the folder where logfiles are saved to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.SystemStorageDto.InternalMetadataFolder">
|
|
<summary>
|
|
Gets or sets the Storage information of the folder where metadata is stored.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.SystemStorageDto.TranscodingTempFolder">
|
|
<summary>
|
|
Gets or sets the Storage information of the transcoding cache.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.SystemInfoDtos.SystemStorageDto.Libraries">
|
|
<summary>
|
|
Gets or sets the storage informations of all libraries.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.UserDtos.AuthenticateUserByName">
|
|
<summary>
|
|
The authenticate user by name request body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserDtos.AuthenticateUserByName.Username">
|
|
<summary>
|
|
Gets or sets the username.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserDtos.AuthenticateUserByName.Pw">
|
|
<summary>
|
|
Gets or sets the plain text password.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.UserDtos.CreateUserByName">
|
|
<summary>
|
|
The create user by name request body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserDtos.CreateUserByName.Name">
|
|
<summary>
|
|
Gets or sets the username.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserDtos.CreateUserByName.Password">
|
|
<summary>
|
|
Gets or sets the password.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.UserDtos.ForgotPasswordDto">
|
|
<summary>
|
|
Forgot Password request body DTO.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserDtos.ForgotPasswordDto.EnteredUsername">
|
|
<summary>
|
|
Gets or sets the entered username to have its password reset.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.UserDtos.ForgotPasswordPinDto">
|
|
<summary>
|
|
Forgot Password Pin enter request body DTO.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserDtos.ForgotPasswordPinDto.Pin">
|
|
<summary>
|
|
Gets or sets the entered pin to have the password reset.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.UserDtos.QuickConnectDto">
|
|
<summary>
|
|
The quick connect request body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserDtos.QuickConnectDto.Secret">
|
|
<summary>
|
|
Gets or sets the quick connect secret.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.UserDtos.UpdateUserPassword">
|
|
<summary>
|
|
The update user password request body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserDtos.UpdateUserPassword.CurrentPassword">
|
|
<summary>
|
|
Gets or sets the current sha1-hashed password.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserDtos.UpdateUserPassword.CurrentPw">
|
|
<summary>
|
|
Gets or sets the current plain text password.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserDtos.UpdateUserPassword.NewPw">
|
|
<summary>
|
|
Gets or sets the new plain text password.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserDtos.UpdateUserPassword.ResetPassword">
|
|
<summary>
|
|
Gets or sets a value indicating whether to reset the password.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Models.UserViewDtos.SpecialViewOptionDto">
|
|
<summary>
|
|
Special view option dto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserViewDtos.SpecialViewOptionDto.Name">
|
|
<summary>
|
|
Gets or sets view option name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.Models.UserViewDtos.SpecialViewOptionDto.Id">
|
|
<summary>
|
|
Gets or sets view option id.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.Results.OkResult`1">
|
|
<summary>
|
|
Ok result with type specified.
|
|
</summary>
|
|
<typeparam name="T">The type to return.</typeparam>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.Results.OkResult`1.#ctor(`0)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.Results.OkResult`1"/> class.
|
|
</summary>
|
|
<param name="value">The value to return.</param>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener">
|
|
<summary>
|
|
Class ActivityLogWebSocketListener.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener._activityManager">
|
|
<summary>
|
|
The _kernel.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener.#ctor(Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener},MediaBrowser.Model.Activity.IActivityManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener"/> class.
|
|
</summary>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="activityManager">Instance of the <see cref="T:MediaBrowser.Model.Activity.IActivityManager"/> interface.</param>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener.Type">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener.StartType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener.StopType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener.GetDataToSend">
|
|
<summary>
|
|
Gets the data to send.
|
|
</summary>
|
|
<returns>Task{SystemInfo}.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener.DisposeAsyncCore">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener.Start(MediaBrowser.Controller.Net.WebSocketMessageInfo)">
|
|
<summary>
|
|
Starts sending messages over an activity log web socket.
|
|
</summary>
|
|
<param name="message">The message.</param>
|
|
</member>
|
|
<member name="T:Jellyfin.Api.WebSocketListeners.ScheduledTasksWebSocketListener">
|
|
<summary>
|
|
Class ScheduledTasksWebSocketListener.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Jellyfin.Api.WebSocketListeners.ScheduledTasksWebSocketListener._taskManager">
|
|
<summary>
|
|
Gets or sets the task manager.
|
|
</summary>
|
|
<value>The task manager.</value>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.ScheduledTasksWebSocketListener.#ctor(Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.WebSocketListeners.ScheduledTasksWebSocketListener},MediaBrowser.Model.Tasks.ITaskManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.WebSocketListeners.ScheduledTasksWebSocketListener"/> class.
|
|
</summary>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="taskManager">Instance of the <see cref="T:MediaBrowser.Model.Tasks.ITaskManager"/> interface.</param>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.WebSocketListeners.ScheduledTasksWebSocketListener.Type">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Jellyfin.Api.WebSocketListeners.ScheduledTasksWebSocketListener.StartType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Jellyfin.Api.WebSocketListeners.ScheduledTasksWebSocketListener.StopType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.ScheduledTasksWebSocketListener.GetDataToSend">
|
|
<summary>
|
|
Gets the data to send.
|
|
</summary>
|
|
<returns>Task{IEnumerable{TaskInfo}}.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.ScheduledTasksWebSocketListener.DisposeAsyncCore">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Jellyfin.Api.WebSocketListeners.SessionInfoWebSocketListener">
|
|
<summary>
|
|
Class SessionInfoWebSocketListener.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.SessionInfoWebSocketListener.#ctor(Microsoft.Extensions.Logging.ILogger{Jellyfin.Api.WebSocketListeners.SessionInfoWebSocketListener},MediaBrowser.Controller.Session.ISessionManager)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Jellyfin.Api.WebSocketListeners.SessionInfoWebSocketListener"/> class.
|
|
</summary>
|
|
<param name="logger">Instance of the <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> interface.</param>
|
|
<param name="sessionManager">Instance of the <see cref="T:MediaBrowser.Controller.Session.ISessionManager"/> interface.</param>
|
|
</member>
|
|
<member name="P:Jellyfin.Api.WebSocketListeners.SessionInfoWebSocketListener.Type">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Jellyfin.Api.WebSocketListeners.SessionInfoWebSocketListener.StartType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Jellyfin.Api.WebSocketListeners.SessionInfoWebSocketListener.StopType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.SessionInfoWebSocketListener.GetDataToSend">
|
|
<summary>
|
|
Gets the data to send.
|
|
</summary>
|
|
<returns>Task{SystemInfo}.</returns>
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.SessionInfoWebSocketListener.GetDataToSendForConnection(MediaBrowser.Controller.Net.IWebSocketConnection)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.SessionInfoWebSocketListener.DisposeAsyncCore">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Jellyfin.Api.WebSocketListeners.SessionInfoWebSocketListener.Start(MediaBrowser.Controller.Net.WebSocketMessageInfo)">
|
|
<summary>
|
|
Starts sending messages over a session info web socket.
|
|
</summary>
|
|
<param name="message">The message.</param>
|
|
</member>
|
|
</members>
|
|
</doc>
|