MediaBrowser.Controller
The exception that is thrown when an attempt to authenticate fails.
Initializes a new instance of the class.
Initializes a new instance of the class.
The message that describes the error.
Initializes a new instance of the class.
The message that describes the error.
The exception that is the cause of the current exception, or a null reference if no inner exception is specified.
A class representing an authentication result.
Gets or sets the user.
Gets or sets the session info.
Gets or sets the access token.
Gets or sets the server id.
Initializes a new instance of the class.
Instance of the interface.
The BaseItem manager.
Is metadata fetcher enabled.
The base item.
The type options for baseItem from the library (if defined).
The metadata fetcher name.
true if metadata fetcher is enabled, else false.
Is image fetcher enabled.
The base item.
The type options for baseItem from the library (if defined).
The image fetcher name.
true if image fetcher is enabled, else false.
Gets the name.
The name.
Gets the description.
The description.
Gets the data version.
The data version.
Gets the home page URL.
The home page URL.
Gets the parental rating.
The parental rating.
Gets the channel information.
ChannelFeatures.
Determines whether [is enabled for] [the specified user].
The user identifier.
true if [is enabled for] [the specified user]; otherwise, false.
Gets the channel items.
The query.
The cancellation token.
Task{IEnumerable{ChannelItem}}.
Gets the channel image.
The type.
The cancellation token.
Task{DynamicImageResponse}.
Gets the supported channel images.
IEnumerable{ImageType}.
Gets the channel features.
The identifier.
ChannelFeatures.
Gets all channel features.
IEnumerable{ChannelFeatures}.
Gets the channel.
The identifier.
Channel.
Gets the channels internal.
The query.
The channels.
Gets the channels.
The query.
The channels.
Gets the latest channel items.
The item query.
The cancellation token.
The latest channels.
Gets the latest channel items.
The item query.
The cancellation token.
The latest channels.
Gets the channel items.
The query.
The cancellation token.
The channel items.
Gets the channel items.
The query.
The progress to report to.
The cancellation token.
The channel items.
Gets the channel item media sources.
The item.
The cancellation token.
The item media sources.
Disable media source display.
can inherit this interface to disable being displayed.
Gets the cache key.
The user identifier.
System.String.
Gets or sets the media types.
The media types.
Gets or sets the content types.
The content types.
Gets or sets the maximum number of records the channel allows retrieving at a time.
Gets or sets the default sort orders.
The default sort orders.
Gets or sets a value indicating whether a sort ascending/descending toggle is supported or not.
Gets or sets the automatic refresh levels.
The automatic refresh levels.
Gets or sets the daily download limit.
The daily download limit.
Gets or sets a value indicating whether [supports downloading].
true if [supports downloading]; otherwise, false.
The channel requires a media info callback.
Gets the channel item media information.
The channel item id.
The cancellation token.
The enumerable of media source info.
Gets the latest media.
The request.
The cancellation token.
The latest media.
Channel supports media probe.
Interface IChapterManager.
Saves the chapters.
The video.
The set of chapters.
Gets a single chapter of a BaseItem on a specific index.
The BaseItems id.
The index of that chapter.
A chapter instance.
Gets all chapters associated with the baseItem.
The BaseItems id.
A readonly list of chapter instances.
Refreshes the chapter images.
Video to use.
Directory service to use.
Set of chapters to refresh.
Option to extract images.
Option to save chapters.
CancellationToken to use for operation.
true if successful, false if not.
Deletes the chapter data.
The item id.
The cancellation token.
Task.
Initializes a new instance of the class.
Instance of the interface.
The client event logger.
Writes a file to the log directory.
The client name writing the document.
The client version writing the document.
The file contents to write.
The created file name.
Gets or sets the collection.
The collection.
Gets or sets the options.
The options.
Gets or sets the collection.
The collection.
Gets or sets the items changed.
The items changed.
Occurs when [collection created].
Occurs when [items added to collection].
Occurs when [items removed from collection].
Creates the collection.
The options.
BoxSet wrapped in an awaitable task.
Adds to collection.
The collection identifier.
The item ids.
representing the asynchronous operation.
Removes from collection.
The collection identifier.
The item ids.
A representing the asynchronous operation.
Collapses the items within box sets.
The items.
The user.
IEnumerable{BaseItem}.
Gets the folder where collections are stored.
Will create the collection folder on the storage if set to true.
The folder instance referencing the collection storage.
Interface IServerConfigurationManager.
Gets the application paths.
The application paths.
Gets the configuration.
The configuration.
Device manager interface.
Event handler for updated device options.
Creates a new device.
The device to create.
A representing the creation of the device.
Saves the capabilities.
The device id.
The capabilities.
Gets the capabilities.
The device id.
ClientCapabilities.
Gets the device information.
The identifier.
DeviceInfoDto.
Gets devices based on the provided query.
The device query.
A representing the retrieval of the devices.
Gets device information based on the provided query.
The device query.
A representing the retrieval of the device information.
Gets the device information.
The user's id, or null.
IEnumerable<DeviceInfoDto>.
Deletes a device.
The device.
A representing the deletion of the device.
Updates a device.
The device.
A representing the update of the device.
Determines whether this instance [can access device] the specified user identifier.
The user to test.
The device id to test.
Whether the user can access the device.
Updates the options of a device.
The device id.
The device name.
A representing the update of the device options.
Gets the options of a device.
The device id.
of the device.
Gets the dto for client capabilities.
The client capabilities.
of the device.
Gets the supported input formats.
The supported input formats.
Gets the supported output formats.
The supported output formats.
Gets the display name for the encoder.
The display name.
Gets a value indicating whether [supports image collage creation].
true if [supports image collage creation]; otherwise, false.
Gets a value indicating whether [supports image encoding].
true if [supports image encoding]; otherwise, false.
Get the dimensions of an image from the filesystem.
The filepath of the image.
The image dimensions.
Gets the blurhash of an image.
Amount of X components of DCT to take.
Amount of Y components of DCT to take.
The filepath of the image.
The blurhash.
Encode an image.
Input path of image.
Date modified.
Output path of image.
Auto-orient image.
Desired orientation of image.
Quality of encoded image.
Image processing options.
Image format of output.
Path of encoded image.
Create an image collage.
The options to use when creating the collage.
Optional.
Creates a new splashscreen image.
The list of poster paths.
The list of backdrop paths.
Creates a new trickplay tile image.
The options to use when creating the image. Width and Height are a quantity of thumbnails in this case, not pixels.
The image encode quality.
The width of a single trickplay thumbnail.
Optional height of a single trickplay thumbnail, if it is known.
Height of single decoded trickplay thumbnail.
Interface IImageProcessor.
Gets the supported input formats.
The supported input formats.
Gets a value indicating whether [supports image collage creation].
true if [supports image collage creation]; otherwise, false.
Gets the dimensions of the image.
Path to the image file.
ImageDimensions.
Gets the dimensions of the image.
The base item.
The information.
ImageDimensions.
Gets the blurhash of the image.
Path to the image file.
BlurHash.
Gets the blurhash of the image.
Path to the image file.
The image dimensions.
BlurHash.
Gets the image cache tag.
The items basePath.
The image last modification date.
Guid.
Gets the image cache tag.
The item.
The image.
Guid.
Gets the image cache tag.
The item.
The image.
Guid.
Gets the image cache tag.
The item.
The image.
Guid.
Processes the image.
The options.
Task.
Gets the supported image output formats.
.
Creates the image collage.
The options.
The library name to draw onto the collage.
Gets or sets the input paths.
The input paths.
Gets or sets the output path.
The output path.
Gets or sets the width.
The width.
Gets or sets the height.
The height.
Interface IDtoService.
Gets the primary image aspect ratio.
The item.
System.Nullable<System.Double>.
Gets the base item dto.
The item.
The options.
The user.
The owner.
BaseItemDto.
Gets the base item dtos.
The items.
The options.
The user.
The owner.
The of .
Gets the item by name dto.
The item.
The dto options.
The list of tagged items.
The user.
The item dto.
Specialized folder that can have items added to it's children by external entities.
Used for our RootFolder so plugins can add items.
The _virtual children.
Gets the virtual children.
The virtual children.
Adds the virtual child.
The child.
Throws if child is null.
Finds the virtual child.
The id.
BaseItem.
The id is empty.
Class Audio.
Gets the type of the media.
The type of the media.
Gets or sets a value indicating whether this audio has lyrics.
Gets or sets the list of lyric paths.
Creates the name of the sort.
System.String.
Gets or sets the artists.
The artists.
Class MusicAlbum.
Gets the tracks.
The tracks.
Class MusicArtist.
Gets the folder containing the item.
If the item is a folder, it returns the folder itself.
The containing folder path.
Gets the user data key.
The item.
System.String.
This is called before any metadata refresh and returns true or false indicating if changes were made.
Option to replace metadata.
True if metadata changed.
Class MusicGenre.
Gets the folder containing the item.
If the item is a folder, it returns the folder itself.
The containing folder path.
This is called before any metadata refresh and returns true or false indicating if changes were made.
Option to replace metadata.
True if metadata changed.
Class BaseItem.
The supported image extensions.
Extra types that should be counted and displayed as "Special Features" in the UI.
Gets or Sets the user data collection as cached from the last Db query.
Gets or sets the album.
The album.
Gets or sets the LUFS value.
The LUFS Value.
Gets or sets the gain required for audio normalization.
The gain required for audio normalization.
Gets or sets the channel identifier.
The channel identifier.
Gets or sets a value indicating whether this instance is in mixed folder.
true if this instance is in mixed folder; otherwise, false.
Gets or sets the name.
The name.
Gets or sets the id.
The id.
Gets or sets the audio.
The audio.
Gets the id that should be used to key display prefs for this item.
Default is based on the type for everything except actual generic folders.
The display prefs id.
Gets or sets the path.
The path.
Gets the folder containing the item.
If the item is a folder, it returns the folder itself.
Gets or sets the name of the service.
The name of the service.
Gets or sets the external id.
If this content came from an external service, the id of the content on that service.
Gets the type of the location.
The type of the location.
Gets the primary image path.
This is just a helper for convenience.
The primary image path.
Gets or sets the date created.
The date created.
Gets or sets the date modified.
The date modified.
Gets or sets the locked fields.
The locked fields.
Gets the type of the media.
The type of the media.
Gets or sets the logger.
Gets or sets the name of the forced sort.
The name of the forced sort.
Gets or sets the name of the sort.
The name of the sort.
Gets or sets the date that the item first debuted. For movies this could be premiere date, episodes would be first aired.
The premiere date.
Gets or sets the end date.
The end date.
Gets or sets the official rating.
The official rating.
Gets or sets the critic rating.
The critic rating.
Gets or sets the custom rating.
The custom rating.
Gets or sets the overview.
The overview.
Gets or sets the studios.
The studios.
Gets or sets the genres.
The genres.
Gets or sets the tags.
The tags.
Gets or sets the home page URL.
The home page URL.
Gets or sets the community rating.
The community rating.
Gets or sets the run time ticks.
The run time ticks.
Gets or sets the production year.
The production year.
Gets or sets the index number. If the item is part of a series, this is it's number in the series.
This could be episode number, album track number, etc.
The index number.
Gets or sets the parent index number. For an episode this could be the season number, or for a song this could be the disc number.
The parent index number.
Gets or sets the provider ids.
The provider ids.
Gets a value indicating whether this instance is folder.
true if this instance is folder; otherwise, false.
Gets or sets the remote trailers.
The remote trailers.
Creates the name of the sort.
System.String.
Finds a parent of a given type.
Type of parent.
``0.
Gets the play access.
The user.
PlayAccess.
The base implementation to refresh metadata.
The options.
The cancellation token.
true if a provider reports we changed.
Refreshes owned items such as trailers, theme videos, special features, etc.
Returns true or false indicating if changes were found.
The metadata refresh options.
The list of filesystem children.
The cancellation token.
true if any items have changed, else false.
Gets the preferred metadata language.
System.String.
Gets the preferred metadata language.
System.String.
Determines if a given user has access to this item.
The user.
Don't check for allowed tags.
true if [is parental allowed] [the specified user]; otherwise, false.
If user is null.
Gets a bool indicating if access to the unrated item is blocked or not.
The configuration.
true if blocked, false otherwise.
Determines if this folder should be visible to a given user.
Default is just parental allowed. Can be overridden for more functionality.
The user.
Don't check for allowed tags.
true if the specified user is visible; otherwise, false.
is null.
Gets the linked child.
The info.
BaseItem.
Adds a studio to the item.
The name.
Throws if name is null.
Adds a genre to the item.
The name.
Throws if name is null.
Marks the played.
The user.
The date played.
if set to true [reset position].
Throws if user is null.
Marks the unplayed.
The user.
Throws if user is null.
Do whatever refreshing is necessary when the filesystem pertaining to this item has changed.
Gets an image.
The type.
Index of the image.
true if the specified type has image; otherwise, false.
Backdrops should be accessed using Item.Backdrops.
Deletes the image.
The type.
The index.
A task.
Validates that images within the item are still on the filesystem.
true if the images validate, false if not.
Gets the image path.
Type of the image.
Index of the image.
System.String.
Item is null.
Gets the image information.
Type of the image.
Index of the image.
ItemImageInfo.
Computes image index for given image or raises if no matching image found.
Image to compute index for.
Image index cannot be computed as no matching image found.
Image index.
Adds the images, updating metadata if they already are part of this item.
Type of the image.
The images.
true if images were added or updated, false otherwise.
Cannot call AddImages with chapter images.
Gets the file system path to delete when the item is to be deleted.
The metadata for the deleted paths.
This is called before any metadata refresh and returns true if changes were made.
Whether to replace all metadata.
true if the item has change, else false.
Updates the official rating based on content and returns true or false indicating if it changed.
Media children.
true if the rating was updated; otherwise false.
Get all extras associated with this item, sorted by .
An enumerable containing the items.
Get all extras with specific types that are associated with this item.
The types of extras to retrieve.
An enumerable containing the extras.
Gets the image path.
The item.
Type of the image.
System.String.
Sets the image path.
The item.
Type of the image.
The file.
Sets the image path.
The item.
Type of the image.
The file.
Copies all properties on object. Skips properties that do not exist.
The source object.
The destination object.
Source type.
Destination type.
Copies all properties on newly created object. Skips properties that do not exist.
The source object.
Source type.
Destination type.
Destination object.
Determines if the item has changed.
The source object.
The timestamp to detect changes as of.
Source type.
Whether the item has changed.
Plugins derive from and export this class to create a folder that will appear in the root along
with all the other actual physical folders in the system.
Specialized Folder class that points to a subset of the physical folders in the system.
It is created from the user-specific folders within the system root.
Initializes a new instance of the class.
Gets the display preferences id.
Allow different display preferences for each collection folder.
The display prefs id.
Gets the item's children.
Our children are actually just references to the ones in the physical root...
The actual children.
Compare our current children (presumably just read from the repo) with the current state of the file system and adjust for any changes
***Currently does not contain logic to maintain items that are unavailable in the file system***.
The progress.
if set to true [recursive].
if set to true [refresh child metadata].
remove item even this folder is root.
The refresh options.
The directory service.
The cancellation token.
Task.
Class Extensions.
Adds the trailer URL.
Media item.
Trailer URL.
Class Folder.
Gets or sets a value indicating whether this instance is root.
true if this instance is root; otherwise, false.
Gets a value indicating whether this instance is folder.
true if this instance is folder; otherwise, false.
Gets or Sets the actual children.
The actual children.
Gets thread-safe access to all recursive children of this folder - without regard to user.
The recursive children.
Adds the child.
The item.
Unable to add + item.Name.
Loads our children. Validation will occur externally.
We want this synchronous.
Returns children.
Validates that the children of the folder still exist.
The progress.
The metadata refresh options.
if set to true [recursive].
remove item even this folder is root.
The cancellation token.
Task.
Validates the children internal.
The progress.
if set to true [recursive].
if set to true [refresh child metadata].
remove item even this folder is root.
The refresh options.
The directory service.
The cancellation token.
Task.
Refreshes the children.
The children.
The directory service.
The progress.
The cancellation token.
Task.
Runs an action block on a list of children.
The task to run for each child.
The list of children.
The progress.
The cancellation token.
Task.
Get the children of this folder from the actual file system.
IEnumerable{BaseItem}.
The directory service to use for operation.
Returns set of base items.
Get our children from the repo - stubbed for now.
IEnumerable{BaseItem}.
Adds the children to list.
Gets the recursive children.
IList{BaseItem}.
Adds the children to list.
Gets the linked children.
IEnumerable{BaseItem}.
Gets the linked children.
IEnumerable{BaseItem}.
Refreshes the linked children.
The enumerable of file system metadata.
true if the linked children were updated, false otherwise.
Marks the played.
The user.
The date played.
if set to true [reset position].
Marks the unplayed.
The user.
Contains constants used when reporting scan progress.
Reported after the folders immediate children are retrieved.
Reported after add, updating, or deleting child items from the LibraryManager.
Reported once subfolders are scanned.
When scanning subfolders, the progress will be between [UpdatedItems, ScannedSubfolders].
Reported once metadata is refreshed.
When refreshing metadata, the progress will be between [ScannedSubfolders, MetadataRefreshed].
Gets the current progress given the previous step, next step, and progress in between.
The previous progress step.
The next progress step.
The current progress step.
The progress.
Class Genre.
Gets the folder containing the item.
If the item is a folder, it returns the folder itself.
The containing folder path.
This is called before any metadata refresh and returns true if changes were made.
Whether to replace all metadata.
true if the item has change, else false.
This is just a marker interface to denote top level folders.
Interface IHasAspectRatio.
Gets or sets the aspect ratio.
The aspect ratio.
Interface IHasDisplayOrder.
Gets or sets the display order.
The display order.
Gets the media sources.
true to enable path substitution, false to not.
A list of media sources.
Gets or sets the name of the series.
The name of the series.
Gets the special feature ids.
The special feature ids.
Gets or sets the remote trailers.
The remote trailers.
Gets the local trailers.
The local trailers.
Class providing extension methods for working with .
Gets the trailer count.
Media item.
.
Marker interface.
Refreshes all metadata.
The refresh options.
The progress.
The cancellation token.
Task.
Gets or sets the minimum ParentIndexNumber and IndexNumber.
It produces this where clause:
(ParentIndexNumber = X and IndexNumber >= Y) or ParentIndexNumber > X.
Gets or sets a value indicating whether album sub-folders should be returned if they exist.
Gets or sets the maximum number of items the query should return.
Marker interface to denote a class that supports being hidden underneath it's boxset.
Just about anything can be placed into a boxset,
but movies should also only appear underneath and not outside separately (subject to configuration).
Gets a value indicating whether this instance is place holder.
true if this instance is place holder; otherwise, false.
Gets or sets the path.
The path.
Gets or sets the type.
The type.
Gets or sets the date modified.
The date modified.
Gets or sets the blurhash.
The blurhash.
Gets or sets the linked item id.
The linked child type.
Manually linked child.
Shortcut linked child.
Compare MediaSource of the same file by Video width .
Class BoxSet.
Gets or sets the display order.
The display order.
Class Movie.
Gets or sets the name of the TMDb collection.
The name of the TMDb collection.
This is the full Person object that can be retrieved with all of it's data.
Gets the folder containing the item.
If the item is a folder, it returns the folder itself.
The containing folder path.
Gets a value indicating whether to enable alpha numeric sorting.
This is called before any metadata refresh and returns true or false indicating if changes were made.
true to replace all metadata, false to not.
true if changes were made, false if not.
This is a small Person stub that is attached to BaseItems.
Gets or Sets the PersonId.
Gets or sets the name.
The name.
Gets or sets the role.
The role.
Gets or sets the type.
The type.
Gets or sets the ascending sort order.
The sort order.
Returns a that represents this instance.
A that represents this instance.
Class Studio.
Gets the folder containing the item.
If the item is a folder, it returns the folder itself.
The containing folder path.
This is called before any metadata refresh and returns true or false indicating if changes were made.
true to replace all metadata, false to not.
true if changes were made, false if not.
Class Trailer.
Class Episode.
Gets or sets the season in which it aired.
The aired season.
Gets or sets the ending episode number for double episodes.
The index number.
Gets the Episode's Series Instance.
The series.
Creates the name of the sort.
System.String.
Determines whether [contains episode number] [the specified number].
The number.
true if [contains episode number] [the specified number]; otherwise, false.
Class Season.
Gets this Episode's Series Instance.
The series.
Creates the name of the sort.
System.String.
Gets the episodes.
The user.
The options to use.
If missing episodes should be included.
Set of episodes.
Gets the lookup information.
SeasonInfo.
This is called before any metadata refresh and returns true or false indicating if changes were made.
true to replace metadata, false to not.
true if XXXX, false otherwise.
Class Series.
Gets or sets the display order.
Valid options are airdate, dvd or absolute.
Gets or sets the status.
The status.
Gets the user data key.
System.String.
Filters the episodes by season.
The episodes.
The season.
true to include special, false to not.
The set of episodes.
Filters the episodes by season.
The episodes.
The season.
true to include special, false to not.
The set of episodes.
Class UserItemData.
The _rating.
Gets or sets the key.
The key.
Gets or sets the users 0-10 rating.
The rating.
Rating;A 0 to 10 rating is required for UserItemData.
Gets or sets the playback position ticks.
The playback position ticks.
Gets or sets the play count.
The play count.
Gets or sets a value indicating whether this instance is favorite.
true if this instance is favorite; otherwise, false.
Gets or sets the last played date.
The last played date.
Gets or sets a value indicating whether this is played.
true if played; otherwise, false.
Gets or sets the index of the audio stream.
The index of the audio stream.
Gets or sets the index of the subtitle stream.
The index of the subtitle stream.
Gets or sets a value indicating whether the item is liked or not.
This should never be serialized.
null if [likes] contains no value, true if [likes]; otherwise, false.
Special class used for User Roots. Children contain actual ones defined for this user
PLUS the virtual folders from the physical root (added by plug-ins).
Initializes a new instance of the class.
Gets or sets the view type.
Gets or sets the display parent id.
Gets or sets the user id.
Class Video.
Gets or sets the timestamp.
The timestamp.
Gets or sets the subtitle paths.
The subtitle paths.
Gets or sets the audio paths.
The audio paths.
Gets or sets a value indicating whether this instance has subtitles.
true if this instance has subtitles; otherwise, false.
Gets or sets the default index of the video stream.
The default index of the video stream.
Gets or sets the type of the video.
The type of the video.
Gets or sets the type of the iso.
The type of the iso.
Gets or sets the video3 D format.
The video3 D format.
Gets or sets the aspect ratio.
The aspect ratio.
Gets a value indicating whether [is3 D].
true if [is3 D]; otherwise, false.
Gets the type of the media.
The type of the media.
Gets the additional parts.
IEnumerable{Video}.
Class Year.
Gets the folder containing the item.
If the item is a folder, it returns the folder itself.
The containing folder path.
This is called before any metadata refresh and returns true if changes were made.
Whether to replace all metadata.
true if the item has change, else false.
A class representing an authentication result event.
Initializes a new instance of the class.
The .
Gets or sets the user name.
Gets or sets the user id.
Gets or sets the app.
Gets or sets the app version.
Gets or sets the device id.
Gets or sets the device name.
Gets or sets the remote endpoint.
A class representing an authentication result event.
Initializes a new instance of the class.
The .
Gets or sets the user.
Gets or sets the session information.
Gets or sets the server id.
An interface representing a type that consumes events of type T.
The type of events this consumes.
A method that is called when an event of type T is fired.
The event.
A task representing the consumption of the event.
An interface that handles eventing.
Publishes an event.
the event arguments.
The type of event.
Publishes an event asynchronously.
The event arguments.
The type of event.
A task representing the publishing of the event.
An event that fires when a session is ended.
Initializes a new instance of the class.
The session info.
An event that fires when a session is started.
Initializes a new instance of the class.
The session info.
An event that occurs when a plugin installation is cancelled.
Initializes a new instance of the class.
The installation info.
An event that occurs when a plugin is installed.
Initializes a new instance of the class.
The installation info.
An event that occurs when a plugin is installing.
Initializes a new instance of the class.
The installation info.
An event that occurs when a plugin is uninstalled.
Initializes a new instance of the class.
The plugin.
An event that occurs when a plugin is updated.
Initializes a new instance of the class.
The installation info.
Configuration extensions for MediaBrowser.Controller.
The key for a setting that specifies the default redirect path
to use for requests where the URL base prefix is invalid or missing..
The key for the address override option.
The key for a setting that indicates whether the application should host web client content.
The key for the FFmpeg probe size option.
The key for the skipping FFmpeg validation.
The key for the FFmpeg analyze duration option.
The key for the FFmpeg image extraction performance tradeoff option.
The key for the FFmpeg path option.
The key for a setting that indicates whether kestrel should bind to a unix socket.
The key for the unix socket path.
The permissions for the unix socket.
The cache size of the SQL database, see cache_size.
The key for a setting that indicates whether the application should detect network status change.
Gets a value indicating whether the application should host static web content from the .
The configuration to retrieve the value from.
The parsed config value.
The config value is not a valid bool string. See .
Gets the FFmpeg probe size from the .
The configuration to read the setting from.
The FFmpeg probe size option.
Gets the FFmpeg analyze duration from the .
The configuration to read the setting from.
The FFmpeg analyze duration option.
Gets a value indicating whether the server should validate FFmpeg during startup.
The configuration to read the setting from.
true if the server should validate FFmpeg during startup, otherwise false.
Gets a value indicating whether the server should trade off for performance during FFmpeg image extraction.
The configuration to read the setting from.
true if the server should trade off for performance during FFmpeg image extraction, otherwise false.
Gets a value indicating whether kestrel should bind to a unix socket from the .
The configuration to read the setting from.
true if kestrel should bind to a unix socket, otherwise false.
Gets the path for the unix socket from the .
The configuration to read the setting from.
The unix socket path.
Gets the permissions for the unix socket from the .
The configuration to read the setting from.
The unix socket permissions.
Gets the cache_size from the .
The configuration to read the setting from.
The sqlite cache size.
Provides extension methods for to parse 's.
Reads a trimmed string from the current node.
The .
The trimmed content.
Reads an int from the current node.
The .
The parsed int.
A value indicating whether the parsing succeeded.
Parses a from the current node.
The .
The parsed .
A value indicating whether the parsing succeeded.
Parses a from the current node.
The .
The date format string.
The parsed .
A value indicating whether the parsing succeeded.
Parses a from the xml node.
The .
A , or null if none is found.
Used to split names of comma or pipe delimited genres and people.
The .
IEnumerable{System.String}.
Parses a array from the xml node.
The .
The .
The .
Manages the storage and retrieval of display preferences.
Gets the display preferences for the user and client.
This will create the display preferences if it does not exist, but it will not save automatically.
The user's id.
The item id.
The client string.
The associated display preferences.
Gets the default item display preferences for the user and client.
This will create the item display preferences if it does not exist, but it will not save automatically.
The user id.
The item id.
The client string.
The item display preferences.
Gets all of the item display preferences for the user and client.
The user id.
The client string.
A list of item display preferences.
Gets all of the custom item display preferences for the user and client.
The user id.
The item id.
The client string.
The dictionary of custom item display preferences.
Sets the custom item display preference for the user and client.
The user id.
The item id.
The client id.
A dictionary of custom item display preferences.
Updates or Creates the display preferences.
The entity to update or create.
Updates or Creates the display preferences for the given item.
The entity to update or create.
Provides low level File access that is much faster than the File/Directory api's.
Gets the filtered file system entries.
The directory service.
The path.
The file system.
The application host.
The logger.
The args.
The flatten folder depth.
if set to true [resolve shortcuts].
Dictionary{System.StringFileSystemInfo}.
is null or empty.
Helper methods for file system management.
Deletes the file.
The fileSystem.
The path.
The logger.
Recursively delete empty folders.
The fileSystem.
The path.
The logger.
Resolves a single link hop for the specified path.
Returns null if the path is not a symbolic link or the filesystem does not support link resolution (e.g., exFAT).
The file path to resolve.
A representing the next link target if the path is a link; otherwise, null.
Gets the target of the specified file link.
This helper exists because of this upstream runtime issue; https://github.com/dotnet/runtime/issues/92128.
The path of the file link.
true to follow links to the final target; false to return the immediate next link.
A if the is a link, regardless of if the target exists; otherwise, null.
Gets the target of the specified file link.
This helper exists because of this upstream runtime issue; https://github.com/dotnet/runtime/issues/92128.
The file info of the file link.
true to follow links to the final target; false to return the immediate next link.
A if the is a link, regardless of if the target exists; otherwise, null.
Interface IPathManager.
Deletes all external item data.
The item.
The cancellation token.
Task.
Interface IPathManager.
Gets the path to the trickplay image base folder.
The item.
Whether or not the tile should be saved next to the media file.
The absolute path.
Gets the path to the subtitle file.
The media source id.
The stream index.
The subtitle file extension.
The absolute path.
Gets the path to the subtitle file.
The media source id.
The absolute path.
Gets the path to the attachment file.
The media source id.
The attachmentFileName index.
The absolute path.
Gets the path to the attachment folder.
The media source id.
The absolute path.
Gets the chapter images data path.
The base item.
The chapter images data path.
Gets the chapter images path.
The base item.
The chapter position.
The chapter images data path.
Gets the paths of extracted data folders.
The base item.
The absolute paths.
Interface IKeyframeManager.
Gets the keyframe data.
The item id.
The keyframe data.
Saves the keyframe data.
The item id.
The keyframe data.
The cancellation token.
The task object representing the asynchronous operation.
Deletes the keyframe data.
The item id.
The cancellation token.
The task object representing the asynchronous operation.
Interface IServerApplicationHost.
Gets the HTTP server port.
The HTTP server port.
Gets the HTTPS port.
The HTTPS port.
Gets a value indicating whether the server should listen on an HTTPS port.
Gets the name of the friendly.
The name of the friendly.
Gets or sets the path to the backup archive used to restore upon restart.
Gets a URL specific for the request.
The instance.
An accessible URL.
Gets a URL specific for the request.
The remote of the connection.
An accessible URL.
Gets a URL specific for the request.
The hostname used in the connection.
An accessible URL.
Gets an URL that can be used to access the API over LAN.
An optional IP address to use.
A value indicating whether to allow HTTPS.
The API URL.
Gets a local (LAN) URL that can be used to access the API.
Note: if passing non-null scheme or port it is up to the caller to ensure they form the correct pair.
The hostname to use in the URL.
The scheme to use for the URL. If null, the scheme will be selected automatically,
preferring HTTPS, if available.
The port to use for the URL. If null, the port will be selected automatically,
preferring the HTTPS port, if available.
The API URL.
Gets the path to the base root media directory.
The root folder path.
Gets the path to the default user view directory. Used if no specific user view is defined.
The default user views path.
Gets the path to the People directory.
The people path.
Gets the path to the Genre directory.
The genre path.
Gets the music genre path.
The music genre path.
Gets the path to the Studio directory.
The studio path.
Gets the path to the Year directory.
The year path.
Gets the path to the user configuration directory.
The user configuration directory path.
Gets the default internal metadata path.
Gets the internal metadata path, either a custom path or the default.
The internal metadata path.
Gets the virtual internal metadata path, either a custom path or the default.
The virtual internal metadata path.
Gets the path to the artists directory.
The artists path.
A service for managing the application instance.
Gets the system info.
The HTTP request.
The .
Gets the public system info.
The HTTP request.
The .
Starts the application restart process.
Starts the application shutdown process.
Gets the systems storage resources.
The .
The direct live TV stream provider.
Deprecated.
Gets the live stream, shared streams seek to the end of the file first.
The stream.
Class BaseIntroProvider.
Gets the name.
The name.
Gets the intros.
The item.
The user.
IEnumerable{System.String}.
Interface ILibraryManager.
Occurs when [item added].
Occurs when [item updated].
Occurs when [item removed].
Gets the root folder.
The root folder.
Resolves the path.
The file information.
The parent.
An instance of .
BaseItem.
Resolves a set of files into a list of BaseItem.
The list of tiles.
Instance of the interface.
The parent folder.
The library options.
The collection type.
The items resolved from the paths.
Gets a Person.
The name of the person.
Task{Person}.
Finds the by path.
The path.
true is the path is a directory; otherwise false.
BaseItem.
Gets the artist.
The name of the artist.
Task{Artist}.
Gets a Studio.
The name of the studio.
Task{Studio}.
Gets a Genre.
The name of the genre.
Task{Genre}.
Gets the genre.
The name of the music genre.
Task{MusicGenre}.
Gets a Year.
The value.
Task{Year}.
Throws if year is invalid.
Validate and refresh the People sub-set of the IBN.
The items are stored in the db but not loaded into memory until actually requested by an operation.
The progress.
The cancellation token.
Task.
Reloads the root media folder.
The progress.
The cancellation token.
Task.
Reloads the root media folder.
The cancellation token.
Is remove the library itself allowed.
Task.
Gets the default view.
IEnumerable{VirtualFolderInfo}.
Gets the item by id.
The id.
BaseItem.
is null.
Gets the item by id, as T.
The item id.
The type of item.
The item.
Gets the item by id, as T, and validates user access.
The item id.
The user id to validate against.
The type of item.
The item if found.
Gets the item by id, as T, and validates user access.
The item id.
The user to validate against.
The type of item.
The item if found.
Gets the intros.
The item.
The user.
IEnumerable{System.String}.
Adds the parts.
The rules.
The resolvers.
The intro providers.
The item comparers.
The post scan tasks.
Sorts the specified items.
The items.
The user.
The sort by.
The sort order.
IEnumerable{BaseItem}.
Gets the user root folder.
UserRootFolder.
Creates the item.
Item to create.
Parent of new item.
Creates the items.
Items to create.
Parent of new items.
CancellationToken to use for operation.
Updates the item.
Items to update.
Parent of updated items.
Reason for update.
CancellationToken to use for operation.
Returns a Task that can be awaited.
Updates the item.
The item.
The parent item.
The update reason.
The cancellation token.
Returns a Task that can be awaited.
Reattaches the user data to the item.
The item.
The cancellation token.
A task that represents the asynchronous reattachment operation.
Retrieves the item.
The id.
BaseItem.
Finds the type of the collection.
The item.
System.String.
Gets the type of the inherited content.
The item.
System.String.
Gets the type of the configured content.
The item.
System.String.
Gets the type of the configured content.
The path.
System.String.
Normalizes the root path list.
The paths.
IEnumerable{System.String}.
Registers the item.
The item.
Deletes the item.
Item to delete.
Options to use for deletion.
Deletes items that are not having any children like Actors.
Items to delete.
In comparison to this method skips a lot of steps assuming there are no children to recusively delete nor does it define the special handling for channels and alike.
Deletes the item.
Item to delete.
Options to use for deletion.
Notify parent of deletion.
Deletes the item.
Item to delete.
Options to use for deletion.
Parent of item.
Notify parent of deletion.
Gets the named view.
The user.
The name.
The parent identifier.
Type of the view.
Name of the sort.
The named view.
Gets the named view.
The user.
The name.
Type of the view.
Name of the sort.
The named view.
Gets the named view.
The name.
Type of the view.
Name of the sort.
The named view.
Gets the named view.
The name.
The parent identifier.
Type of the view.
Name of the sort.
The unique identifier.
The named view.
Gets the shadow view.
The parent.
Type of the view.
Name of the sort.
The shadow view.
Gets the season number from path.
The path.
The parent id.
System.Nullable<System.Int32>.
Fills the missing episode numbers from path.
Episode to use.
Option to force refresh of episode numbers.
True if successful.
Parses the name.
The name.
ItemInfo.
Gets the new item identifier.
The key.
The type.
Guid.
Finds the extras.
The owner.
The file system children.
An instance of .
IEnumerable<BaseItem>.
Gets the collection folders.
The item.
The folders that contain the item.
Gets the collection folders.
The item.
The root folders to consider.
The folders that contain the item.
Gets the people.
The item.
List<PersonInfo>.
Gets the people.
The query.
List<PersonInfo>.
Gets the people items.
The query.
List<Person>.
Updates the people.
The item.
The people.
Asynchronously updates the people.
The item.
The people.
The cancellation token.
The async task.
Gets the item ids.
The query.
List<Guid>.
Gets the people names.
The query.
List<System.String>.
Queries the items.
The query.
QueryResult<BaseItem>.
Converts the image to local.
The item.
The image.
Index of the image.
Whether to remove the image from the item on failure.
Task.
Gets the items.
The query.
QueryResult<BaseItem>.
Gets the items.
The query to use.
Items to use for query.
List of items.
Gets the TVShow/Album items for Latest api.
The query to use.
Items to use for query.
Collection Type.
List of items.
Gets the list of series presentation keys for next up.
The query to use.
Items to use for query.
The minimum date for a series to have been most recently watched.
List of series presentation keys.
Gets the items result.
The query.
QueryResult<BaseItem>.
Checks if the file is ignored.
The file.
The parent.
true if ignored, false otherwise.
Queue a library scan.
This exists so plugins can trigger a library scan.
Add mblink file for a media path.
The path to the virtualfolder.
The new virtualfolder.
Service responsible for monitoring library filesystems for changes.
Starts this instance.
Stops this instance.
Reports the file system change beginning.
The path.
Reports the file system change complete.
The path.
if set to true [refresh path].
Reports the file system changed.
The path.
An interface for tasks that run after the media library scan.
Runs the specified progress.
The progress.
The cancellation token.
Task.
Adds the parts.
The providers.
Gets the media streams.
The item identifier.
IEnumerable<MediaStream>.
Gets the media streams.
The query.
IEnumerable<MediaStream>.
Gets the media attachments.
The item identifier.
IEnumerable<MediaAttachment>.
Gets the media attachments.
The query.
IEnumerable<MediaAttachment>.
Gets the playback media sources.
Item to use.
User to use for operation.
Option to allow media probe.
Option to enable path substitution.
CancellationToken to use for operation.
List of media sources wrapped in an awaitable task.
Gets the static media sources.
Item to use.
Option to enable path substitution.
User to use for operation.
List of media sources.
Gets the static media source.
Item to use.
Media source to get.
Live stream to use.
Option to enable path substitution.
CancellationToken to use for operation.
The static media source wrapped in an awaitable task.
Opens the media source.
The request.
The cancellation token.
Task<MediaSourceInfo>.
Gets the live stream.
The identifier.
The cancellation token.
Task<MediaSourceInfo>.
Gets the live stream info.
The identifier.
An instance of .
Gets the live stream info using the stream's unique id.
The unique identifier.
An instance of .
Gets the media sources for an active recording.
The .
The .
A task containing the 's for the recording.
Closes the media source.
The live stream identifier.
Task.
Gets the media sources.
The item.
The cancellation token.
Task<IEnumerable<MediaSourceInfo>>.
Opens the media source.
Token to use.
List of live streams.
CancellationToken to use for operation.
The media source wrapped as an awaitable task.
Gets the save path.
The item.
System.String.
Interface IMetadataSaver.
Gets the name.
The name.
Determines whether [is enabled for] [the specified item].
The item.
Type of the update.
true if [is enabled for] [the specified item]; otherwise, false.
Saves the specified item.
The item.
The cancellation token.
The task object representing the asynchronous operation.
Gets the instant mix from song.
The item to use.
The user to use.
The options to use.
List of items.
Gets the instant mix from artist.
The artist to use.
The user to use.
The options to use.
List of items.
Gets the instant mix from genre.
The genres to use.
The user to use.
The options to use.
List of items.
Gets or sets the path.
The path.
Gets or sets the item id.
The item id.
Interface ILibrarySearchEngine.
Gets the search hints.
The query.
Task{IEnumerable{SearchHintInfo}}.
Class ItemChangeEventArgs.
Gets or sets the item.
The item.
Gets or sets the item.
The item.
These are arguments relating to the file system that are collected once and then referred to
whenever needed. Primarily for entity resolution.
The _app paths.
Initializes a new instance of the class.
The app paths.
The library manager.
Gets or sets the file system children.
The file system children.
Gets or sets the parent.
The parent.
Gets or sets the file info.
The file info.
Gets the path.
The path.
Gets a value indicating whether this instance is directory.
true if this instance is directory; otherwise, false.
Gets a value indicating whether this instance is vf.
true if this instance is vf; otherwise, false.
Gets a value indicating whether this instance is physical root.
true if this instance is physical root; otherwise, false.
Gets or sets the additional locations.
The additional locations.
Gets the physical locations.
The physical locations.
Determines whether the specified is equal to this instance.
The object to compare with the current object.
true if the specified is equal to this instance; otherwise, false.
Adds the additional location.
The path.
is null or empty.
Gets the name of the file system entry by.
The name.
FileSystemInfo.
is null or empty.
Gets the file system entry by path.
The path.
FileSystemInfo.
Throws if path is invalid.
Determines whether [contains file system entry by name] [the specified name].
The name.
true if [contains file system entry by name] [the specified name]; otherwise, false.
Gets the configured content type for the path.
The configured content type.
Gets the file system children that do not hit the ignore file check.
The file system children that are not ignored.
Returns a hash code for this instance.
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
Equals the specified args.
The args.
true if the arguments are the same, false otherwise.
Interface IUserDataManager.
Occurs when [user data saved].
Saves the user data.
The user.
The item.
The user data.
The reason.
The cancellation token.
Save the provided user data for the given user.
The user.
The item.
The reason for updating the user data.
The reason.
Gets the user data.
User to use.
Item to use.
User data.
Gets the user data dto.
Item to use.
User to use.
User data dto.
Gets the user data dto.
Item to use.
Item dto to use.
User to use.
Dto options to use.
User data dto.
Updates playstate for an item and returns true or false indicating if it was played to completion.
Item to update.
Data to update.
New playstate.
True if playstate was updated.
Interface IUserManager.
Occurs when a user is updated.
Gets the users.
The users.
Gets the user ids.
The users ids.
Initializes the user manager and ensures that a user exists.
Awaitable task.
Gets a user by Id.
The id.
The user with the specified Id, or null if the user doesn't exist.
id is an empty Guid.
Gets the name of the user by.
The name.
User.
Renames the user.
The user.
The new name.
Task.
If user is null.
If the provided user doesn't exist.
Updates the user.
The user.
If user is null.
If the provided user doesn't exist.
A task representing the update of the user.
Creates a user with the specified name.
The name of the new user.
The created user.
is null or empty.
already exists.
Deletes the specified user.
The id of the user to be deleted.
A task representing the deletion of the user.
Resets the password.
The user.
Task.
Changes the password.
The user.
New password to use.
Awaitable task.
Gets the user dto.
The user.
The remote end point.
UserDto.
Authenticates the user.
The user.
The password to use.
Remove endpoint to use.
Specifies if a user session.
User wrapped in awaitable task.
Starts the forgot password process.
The entered username.
if set to true [is in network].
ForgotPasswordResult.
Redeems the password reset pin.
The pin.
true if XXXX, false otherwise.
This method updates the user's configuration.
This is only included as a stopgap until the new API, using this internally is not recommended.
Instead, modify the user object directly, then call .
The user's Id.
The request containing the new user configuration.
A task representing the update.
This method updates the user's policy.
This is only included as a stopgap until the new API, using this internally is not recommended.
Instead, modify the user object directly, then call .
The user's Id.
The request containing the new user policy.
A task representing the update.
Clears the user's profile image.
The user.
A task representing the clearing of the profile image.
Gets user views.
Query to use.
Set of folders.
Gets user sub views.
Parent to use.
Type to use.
Localization key to use.
Sort to use.
User view.
Gets latest items.
Query to use.
Options to use.
Set of items.
Gets the for the specified type.
The .
The type to get the for.
The for the specified type or null.
Holds information about a playback progress event.
An event that occurs when playback is started.
Gets or sets a value indicating whether [played to completion].
true if [played to completion]; otherwise, false.
Class SearchHintInfo.
Gets or sets the item.
The item.
Gets or sets the matched term.
The matched term.
Class TVUtils.
Gets the air days.
The day.
List{DayOfWeek}.
Class UserDataSaveEventArgs.
Gets or sets the user id.
The user id.
Gets or sets the save reason.
The save reason.
Gets or sets the user data.
The user data.
Gets or sets the item.
The item.
Provides a shared scheduler to run library related tasks based on the .
Enqueues an action that will be invoked with the set data.
The data Type.
The data.
The callback to process the data.
A progress reporter.
Stop token.
A task that finishes when all data has been processed by the worker.
Provides Parallel action interface to process tasks with a set concurrency level.
Gets used to lock all operations on the Tasks queue and creating workers.
Initializes a new instance of the class.
The hosting lifetime.
The logger.
The server configuration manager.
Class ChannelInfo.
Gets or sets the name.
The name.
Gets or sets the number.
The number.
Gets or sets the Id.
The id of the channel.
Gets or sets the tuner host identifier.
The tuner host identifier.
Gets or sets the type of the channel.
The type of the channel.
Gets or sets the group of the channel.
The group of the channel.
Gets or sets the image path if it can be accessed directly from the file system.
The image path.
Gets or sets the image url if it can be downloaded.
The image URL.
Gets or sets a value indicating whether this instance has image.
null if [has image] contains no value, true if [has image]; otherwise, false.
Gets or sets a value indicating whether this instance is favorite.
null if [is favorite] contains no value, true if [is favorite]; otherwise, false.
Service responsible for managing the Live TV guide.
Gets the guide information.
The .
Refresh the guide.
The to use.
The to use.
Task representing the refresh operation.
Service responsible for managing s and mapping
their channels to channels provided by s.
Saves the listing provider.
The listing provider information.
A value indicating whether to validate login.
A value indicating whether to validate listings..
Task.
Deletes the listing provider.
The listing provider's id.
Gets the lineups.
Type of the provider.
The provider identifier.
The country.
The location.
The available lineups.
Gets the programs for a provided channel.
The channel to retrieve programs for.
The earliest date to retrieve programs for.
The latest date to retrieve programs for.
The to use.
The available programs.
Adds metadata from the s to the provided channels.
The channels.
A value indicating whether to use the EPG channel cache.
The to use.
A task representing the metadata population.
Gets the channel mapping options for a provider.
The id of the provider to use.
The channel mapping options.
Sets the channel mapping.
The id of the provider for the mapping.
The tuner channel number.
The provider channel number.
The updated channel mapping.
Manages all live tv services installed on the server.
Gets the services.
The services.
Gets the new timer defaults asynchronous.
The cancellation token.
Task{TimerInfo}.
Gets the new timer defaults.
The program identifier.
The cancellation token.
Task{SeriesTimerInfoDto}.
Cancels the timer.
The identifier.
Task.
Cancels the series timer.
The identifier.
Task.
Gets the timer.
The identifier.
The cancellation token.
Task{TimerInfoDto}.
Gets the series timer.
The identifier.
The cancellation token.
Task{TimerInfoDto}.
Gets the recordings.
The query.
The options.
A recording.
Gets the timers.
The query.
The cancellation token.
Task{QueryResult{TimerInfoDto}}.
Gets the series timers.
The query.
The cancellation token.
Task{QueryResult{SeriesTimerInfoDto}}.
Gets the program.
The identifier.
The cancellation token.
The user.
Task{ProgramInfoDto}.
Gets the programs.
The query.
The options.
The cancellation token.
IEnumerable{ProgramInfo}.
Updates the timer.
The timer.
The cancellation token.
Task.
Updates the timer.
The timer.
The cancellation token.
Task.
Creates the timer.
The timer.
The cancellation token.
Task.
Creates the series timer.
The timer.
The cancellation token.
Task.
Gets the recommended programs.
The query.
The options.
The cancellation token.
Recommended programs.
Gets the recommended programs internal.
The query.
The options.
The cancellation token.
Recommended programs.
Gets the live tv information.
The cancellation token.
Task{LiveTvInfo}.
Resets the tuner.
The identifier.
The cancellation token.
Task.
Gets the live tv folder.
The cancellation token.
Live TV folder.
Gets the enabled users.
IEnumerable{User}.
Gets the internal channels.
The query.
The options.
The cancellation token.
Internal channels.
Adds the information to program dto.
The programs.
The fields.
The user.
Task.
Adds the channel information.
The items.
The options.
The user.
Represents a single live tv back end (next pvr, media portal, etc).
Gets the name.
The name.
Gets the home page URL.
The home page URL.
Gets the channels async.
The cancellation token.
Task{IEnumerable{ChannelInfo}}.
Cancels the timer asynchronous.
The timer identifier.
The cancellation token.
Task.
Cancels the series timer asynchronous.
The timer identifier.
The cancellation token.
Task.
Creates the timer asynchronous.
The information.
The cancellation token.
Task.
Creates the series timer asynchronous.
The information.
The cancellation token.
Task.
Updates the timer asynchronous.
The updated timer information.
The cancellation token.
Task.
Updates the series timer asynchronous.
The information.
The cancellation token.
Task.
Gets the recordings asynchronous.
The cancellation token.
Task{IEnumerable{RecordingInfo}}.
Gets the new timer defaults asynchronous.
The cancellation token.
The program.
Task{SeriesTimerInfo}.
Gets the series timers asynchronous.
The cancellation token.
Task{IEnumerable{SeriesTimerInfo}}.
Gets the programs asynchronous.
The channel identifier.
The start date UTC.
The end date UTC.
The cancellation token.
Task{IEnumerable{ProgramInfo}}.
Gets the channel stream.
The channel identifier.
The stream identifier.
The cancellation token.
Task{Stream}.
Gets the channel stream media sources.
The channel identifier.
The cancellation token.
Task<List<MediaSourceInfo>>.
Closes the live stream.
The identifier.
The cancellation token.
Task.
Resets the tuner.
The identifier.
The cancellation token.
Task.
Creates the timer asynchronous.
The information.
The cancellation token.
Task.
Creates the series timer asynchronous.
The information.
The cancellation token.
Task.
Service responsible for managing LiveTV recordings.
Gets the path for the provided timer id.
The timer id.
The recording path, or null if none exists.
Gets the information for an active recording.
The recording path.
The , or null if none exists.
Gets the recording folders.
The for each recording folder.
Ensures that the recording folders all exist, and removes unused folders.
Task.
Cancels the recording with the provided timer id, if one is active.
The timer id.
The timer.
Records a stream.
The recording info.
The channel associated with the recording timer.
The time to stop recording.
Task representing the recording process.
Gets the name.
The name.
Gets the type.
The type.
Gets the channels.
Option to enable using cache.
The CancellationToken for this operation.
Task<IEnumerable<ChannelInfo>>.
Gets the channel stream.
The channel identifier.
The stream identifier.
The current live streams.
The cancellation token to cancel operation.
Live stream wrapped in a task.
Gets the channel stream media sources.
The channel identifier.
The cancellation token.
Task<List<MediaSourceInfo>>.
Validates the specified information.
The information.
Task.
Service responsible for managing the s.
Gets the available s.
Gets the s for the available s.
The s.
Saves the tuner host.
Turner host to save.
Option to specify that data source has changed.
Tuner host information wrapped in a task.
Discovers the available tuners.
A value indicating whether to only return new devices.
The s.
Scans for tuner devices that have changed URLs.
The to use.
A task that represents the scanning operation.
Gets or sets the number.
The number.
Gets or sets the type of the channel.
The type of the channel.
Gets or sets a value indicating whether this instance is sports.
true if this instance is sports; otherwise, false.
Gets or sets a value indicating whether this instance is series.
true if this instance is series; otherwise, false.
Gets or sets a value indicating whether this instance is news.
true if this instance is news; otherwise, false.
Gets a value indicating whether this instance is kids.
true if this instance is kids; otherwise, false.
Gets or sets the episode title.
The episode title.
Class LiveTvConflictException.
Gets or sets start date of the program, in UTC.
Gets or sets a value indicating whether this instance is repeat.
true if this instance is repeat; otherwise, false.
Gets or sets the episode title.
The episode title.
Gets or sets a value indicating whether this instance is movie.
true if this instance is movie; otherwise, false.
Gets a value indicating whether this instance is sports.
true if this instance is sports; otherwise, false.
Gets or sets a value indicating whether this instance is series.
true if this instance is series; otherwise, false.
Gets a value indicating whether this instance is live.
true if this instance is live; otherwise, false.
Gets a value indicating whether this instance is news.
true if this instance is news; otherwise, false.
Gets a value indicating whether this instance is kids.
true if this instance is kids; otherwise, false.
Gets a value indicating whether this instance is premiere.
true if this instance is premiere; otherwise, false.
Gets the folder containing the item.
If the item is a folder, it returns the folder itself.
The containing folder path.
Gets or sets the id of the program.
Gets or sets the channel identifier.
The channel identifier.
Gets or sets the name of the program.
Gets or sets the official rating.
The official rating.
Gets or sets the overview.
The overview.
Gets or sets the short overview.
The short overview.
Gets or sets the start date of the program, in UTC.
Gets or sets the end date of the program, in UTC.
Gets or sets the genre of the program.
Gets or sets the original air date.
The original air date.
Gets or sets a value indicating whether this instance is hd.
true if this instance is hd; otherwise, false.
Gets or sets a value indicating whether this instance is 3d.
Gets or sets the audio.
The audio.
Gets or sets the community rating.
The community rating.
Gets or sets a value indicating whether this instance is repeat.
true if this instance is repeat; otherwise, false.
Gets or sets the episode title.
The episode title.
Gets or sets the image path if it can be accessed directly from the file system.
The image path.
Gets or sets the image url if it can be downloaded.
The image URL.
Gets or sets a value indicating whether this instance has image.
null if [has image] contains no value, true if [has image]; otherwise, false.
Gets or sets a value indicating whether this instance is movie.
true if this instance is movie; otherwise, false.
Gets or sets a value indicating whether this instance is sports.
true if this instance is sports; otherwise, false.
Gets or sets a value indicating whether this instance is series.
true if this instance is series; otherwise, false.
Gets or sets a value indicating whether this instance is live.
true if this instance is live; otherwise, false.
Gets or sets a value indicating whether this instance is news.
true if this instance is news; otherwise, false.
Gets or sets a value indicating whether this instance is kids.
true if this instance is kids; otherwise, false.
Gets or sets a value indicating whether this instance is premiere.
true if this instance is premiere; otherwise, false.
Gets or sets the production year.
The production year.
Gets or sets the home page URL.
The home page URL.
Gets or sets the series identifier.
The series identifier.
Gets or sets the show identifier.
The show identifier.
Gets or sets the season number.
The season number.
Gets or sets the episode number.
The episode number.
Gets or sets the etag.
The etag.
Gets or sets the id of the recording.
Gets or sets the channelId of the recording.
Gets or sets the program identifier.
The program identifier.
Gets or sets the name of the recording.
Gets or sets the service name.
Gets or sets the description of the recording.
Gets or sets the start date of the recording, in UTC.
Gets or sets the end date of the recording, in UTC.
Gets or sets a value indicating whether [record any time].
true if [record any time]; otherwise, false.
Gets or sets a value indicating whether [record any channel].
true if [record any channel]; otherwise, false.
Gets or sets a value indicating whether [record new only].
true if [record new only]; otherwise, false.
Gets or sets the days.
The days.
Gets or sets the priority.
The priority.
Gets or sets the pre padding seconds.
The pre padding seconds.
Gets or sets the post padding seconds.
The post padding seconds.
Gets or sets a value indicating whether this instance is pre padding required.
true if this instance is pre padding required; otherwise, false.
Gets or sets a value indicating whether this instance is post padding required.
true if this instance is post padding required; otherwise, false.
Gets or sets the series identifier.
The series identifier.
Gets or sets the id of the recording.
Gets or sets the series timer identifier.
Gets or sets the channelId of the recording.
Gets or sets the program identifier.
The program identifier.
Gets or sets the name of the recording.
Gets or sets the description of the recording.
Gets or sets the start date of the recording, in UTC.
Gets or sets the end date of the recording, in UTC.
Gets or sets the status.
The status.
Gets or sets the pre padding seconds.
The pre padding seconds.
Gets or sets the post padding seconds.
The post padding seconds.
Gets or sets a value indicating whether this instance is pre padding required.
true if this instance is pre padding required; otherwise, false.
Gets or sets a value indicating whether this instance is post padding required.
true if this instance is post padding required; otherwise, false.
Gets or sets the priority.
The priority.
Gets or sets the episode number.
The episode number.
Gets a value indicating whether this instance is live.
true if this instance is live; otherwise, false.
Interface ILyricManager.
Occurs when a lyric download fails.
Search for lyrics for the specified song.
The song.
Whether the request is automated.
CancellationToken to use for the operation.
The list of lyrics.
Search for lyrics.
The search request.
CancellationToken to use for the operation.
The list of lyrics.
Download the lyrics.
The audio.
The remote lyric id.
CancellationToken to use for the operation.
The downloaded lyrics.
Download the lyrics.
The audio.
The library options to use.
The remote lyric id.
CancellationToken to use for the operation.
The downloaded lyrics.
Saves new lyrics.
The audio file the lyrics belong to.
The lyrics format.
The lyrics.
A representing the asynchronous operation.
Saves new lyrics.
The audio file the lyrics belong to.
The lyrics format.
The lyrics.
A representing the asynchronous operation.
Get the remote lyrics.
The remote lyrics id.
CancellationToken to use for the operation.
The lyric response.
Deletes the lyrics.
The audio file to remove lyrics from.
A representing the asynchronous operation.
Get the list of lyric providers.
The item.
Lyric providers.
Get the existing lyric for the audio.
The audio item.
The cancellation token.
The parsed lyric model.
Interface ILyricParser.
Gets a value indicating the provider name.
Gets the priority.
The priority.
Parses the raw lyrics into a response.
The raw lyrics content.
The parsed lyrics or null if invalid.
Interface ILyricsProvider.
Gets the provider name.
Search for lyrics.
The search request.
The cancellation token.
The list of remote lyrics.
Get the lyrics.
The remote lyric id.
The cancellation token.
The lyric response.
An event that occurs when subtitle downloading fails.
Gets or sets the item.
Gets or sets the provider.
Gets or sets the exception.
Gets or sets the id.
The id.
Gets or sets the audio codec.
The audio codec.
Gets or sets the audio sample rate.
The audio sample rate.
Gets or sets the audio bit rate.
The audio bit rate.
Gets or sets the audio channels.
The audio channels.
Gets or sets the profile.
The profile.
Gets or sets the video range type.
The video range type.
Gets or sets the level.
The level.
Gets or sets the codec tag.
The codec tag.
Gets or sets the framerate.
The framerate.
Gets or sets the start time ticks.
The start time ticks.
Gets or sets the width.
The width.
Gets or sets the height.
The height.
Gets or sets the width of the max.
The width of the max.
Gets or sets the height of the max.
The height of the max.
Gets or sets the video bit rate.
The video bit rate.
Gets or sets the index of the subtitle stream.
The index of the subtitle stream.
Gets or sets the video codec.
The video codec.
Gets or sets the index of the audio stream.
The index of the audio stream.
Gets or sets the index of the video stream.
The index of the video stream.
Enum BitStreamFilterOptionType.
hevc_metadata bsf with remove_dovi option.
hevc_metadata bsf with remove_hdr10plus option.
av1_metadata bsf with remove_dovi option.
av1_metadata bsf with remove_hdr10plus option.
dovi_rpu bsf with strip option.
Describes the downmix algorithms capabilities.
The filter string of the DownMixStereoAlgorithms.
The index is the tuple of (algorithm, layout).
Get the audio channel layout string from the audio stream
If the input audio string does not have a valid layout string, guess from channel count.
The audio stream to get layout.
Channel Layout string.
The codec validation regex string.
This regular expression matches strings that consist of alphanumeric characters, hyphens,
periods, underscores, commas, and vertical bars, with a length between 0 and 40 characters.
This should matches all common valid codecs.
The level validation regex string.
This regular expression matches strings representing a double.
Pattern:
^[a-zA-Z0-9\\-\\._,|]{0,40}$
Explanation:
○ Match if at the beginning of the string.
○ Match a character in the set [,-.0-9A-Z_a-z|] atomically at most 40 times.
○ Match if at the end of the string or if before an ending newline.
Pattern:
\\s+
Explanation:
○ Match a whitespace character atomically at least once.
Gets the name of the output video codec.
Encoding state.
Encoding options.
Encoder string.
Gets the user agent param.
The state.
System.String.
Gets the referer param.
The state.
System.String.
Gets decoder from a codec.
Codec to use.
Decoder string.
Infers the audio codec based on the url.
Container to use.
Codec string.
Infers the video codec.
The URL.
System.Nullable{VideoCodecs}.
Gets the audio encoder.
The state.
System.String.
Gets the input video hwaccel argument.
Encoding state.
Encoding options.
Input video hwaccel arguments.
Gets the input argument.
Encoding state.
Encoding options.
Segment Container.
Input arguments.
Determines whether the specified stream is H264.
The stream.
true if the specified stream is H264; otherwise, false.
Check if dynamic HDR metadata should be removed during stream copy.
Please note this check assumes the range check has already been done
and trivial fallbacks like HDR10+ to HDR10, DOVIWithHDR10 to HDR10 is already checked.
Gets the text subtitle param.
The state.
Enable alpha processing.
Enable sub2video mode.
System.String.
Gets the video bitrate to specify on the command line.
Encoding state.
Video encoder to use.
Encoding options.
Default present to use for encoding.
Video bitrate.
Gets the number of audio channels to specify on the command line.
The state.
The audio stream.
The output audio codec.
System.Nullable{System.Int32}.
Enforces the resolution limit.
The state.
Gets the fast seek command line parameter.
The state.
The options.
Segment Container.
System.String.
The fast seek command line parameter.
Gets the map args.
The state.
System.String.
Gets the negative map args by filters.
The state.
The videoProcessFilters.
System.String.
Determines which stream will be used for playback.
All stream.
Index of the desired.
The type.
if set to true [return first if no index].
MediaStream.
Gets the parameter of software filter chain.
Encoding state.
Encoding options.
Video encoder to use.
The tuple contains three lists: main, sub and overlay filters.
Gets the parameter of Nvidia NVENC filter chain.
Encoding state.
Encoding options.
Video encoder to use.
The tuple contains three lists: main, sub and overlay filters.
Gets the parameter of AMD AMF filter chain.
Encoding state.
Encoding options.
Video encoder to use.
The tuple contains three lists: main, sub and overlay filters.
Gets the parameter of Intel QSV filter chain.
Encoding state.
Encoding options.
Video encoder to use.
The tuple contains three lists: main, sub and overlay filters.
Gets the parameter of Intel/AMD VAAPI filter chain.
Encoding state.
Encoding options.
Video encoder to use.
The tuple contains three lists: main, sub and overlay filters.
Gets the parameter of Apple VideoToolBox filter chain.
Encoding state.
Encoding options.
Video encoder to use.
The tuple contains three lists: main, sub and overlay filters.
Gets the parameter of Rockchip RKMPP/RKRGA filter chain.
Encoding state.
Encoding options.
Video encoder to use.
The tuple contains three lists: main, sub and overlay filters.
Gets the parameter of video processing filters.
Encoding state.
Encoding options.
Video codec to use.
The video processing filters parameter.
Gets the ffmpeg option string for the hardware accelerated video decoder.
The encoding job info.
The encoding options.
The option string or null if none available.
Gets a hw decoder name.
Encoding options.
Decoder prefix.
Decoder suffix.
Video codec to use.
Video color bit depth.
Hardware decoder name.
Gets a hwaccel type to use as a hardware decoder depending on the system.
Encoding state.
Encoding options.
Video codec to use.
Video color bit depth.
Specifies if output hw surface.
Hardware accelerator type.
Gets the number of threads.
Encoding state.
Encoding options.
Video codec to use.
Number of threads.
Gets the target video level.
Gets the target video bit depth.
Gets the target reference frames.
The target reference frames.
Gets the target framerate.
Gets the target packet length.
Gets the target video profile.
Gets the target video range type.
Enum FilterOptionType.
The scale_cuda_format.
The tonemap_cuda_name.
The tonemap_opencl_bt2390.
The overlay_opencl_framesync.
The overlay_vaapi_framesync.
The overlay_vulkan_framesync.
The transpose_opencl_reversal.
The overlay_opencl_alpha_format.
The overlay_cuda_alpha_format.
Gets the path to the attachment file.
The .
The media source id.
The attachment index.
The cancellation token.
The async task.
Gets the path to the attachment file.
The input file path.
The source id.
The cancellation token.
The async task.
Interface IMediaEncoder.
Gets the encoder path.
The encoder path.
Gets the probe path.
The probe path.
Gets the version of encoder.
The version of encoder.
Gets a value indicating whether p key pausing is supported.
true if p key pausing is supported, false otherwise.
Gets a value indicating whether the configured Vaapi device is from AMD(radeonsi/r600 Mesa driver).
true if the Vaapi device is an AMD(radeonsi/r600 Mesa driver) GPU, false otherwise.
Gets a value indicating whether the configured Vaapi device is from Intel(iHD driver).
true if the Vaapi device is an Intel(iHD driver) GPU, false otherwise.
Gets a value indicating whether the configured Vaapi device is from Intel(legacy i965 driver).
true if the Vaapi device is an Intel(legacy i965 driver) GPU, false otherwise.
Gets a value indicating whether the configured Vaapi device supports vulkan drm format modifier.
true if the Vaapi device supports vulkan drm format modifier, false otherwise.
Gets a value indicating whether the configured Vaapi device supports vulkan drm interop via dma-buf.
true if the Vaapi device supports vulkan drm interop, false otherwise.
Gets a value indicating whether av1 decoding is available via VideoToolbox.
true if the av1 is available via VideoToolbox, false otherwise.
Whether given encoder codec is supported.
The encoder.
true if XXXX, false otherwise.
Whether given decoder codec is supported.
The decoder.
true if XXXX, false otherwise.
Whether given hardware acceleration type is supported.
The hwaccel.
true if XXXX, false otherwise.
Whether given filter is supported.
The filter.
true if the filter is supported, false otherwise.
Whether filter is supported with the given option.
The option.
true if the filter is supported, false otherwise.
Whether the bitstream filter is supported with the given option.
The option.
true if the bitstream filter is supported, false otherwise.
Extracts the audio image.
The path.
Index of the image stream.
The cancellation token.
Task{Stream}.
Extracts the video image.
Input file.
Video container type.
Media source information.
Media stream information.
Video 3D format.
Time offset.
CancellationToken to use for operation.
Location of video image.
Extracts the video image.
Input file.
Video container type.
Media source information.
Media stream information.
Index of the stream to extract from.
The format of the file to write.
CancellationToken to use for operation.
Location of video image.
Extracts the video images on interval.
Input file.
Video container type.
Media source information.
Media stream information.
The maximum width.
The interval.
Allow for hardware acceleration.
Use hardware mjpeg encoder.
The input/output thread count for ffmpeg.
The qscale value for ffmpeg.
The process priority for the ffmpeg process.
Whether to only extract key frames.
EncodingHelper instance.
The cancellation token.
Directory where images where extracted. A given image made before another will always be named with a lower number.
Gets the media info.
The request.
The cancellation token.
Task.
Gets the input argument.
The input file.
The mediaSource.
System.String.
Gets the input argument.
The input files.
The mediaSource.
System.String.
Gets the input argument for an external subtitle file.
The input file.
System.String.
Gets the time parameter.
The ticks.
System.String.
Escapes the subtitle filter path.
The path.
System.String.
Sets the path to find FFmpeg.
bool indicates whether a valid ffmpeg is found.
Gets the primary playlist of .vob files.
The to the .vob files.
The title number to start with.
A playlist.
Gets the primary playlist of .m2ts files.
The to the .m2ts files.
A playlist.
Gets the input path argument from .
The .
The input path argument.
Gets the input path argument.
The item path.
The .
The input path argument.
Generates a FFmpeg concat config for the source.
The .
The path the config should be written to.
Gets the subtitles.
Item to use.
Media source.
Subtitle stream to use.
Output format to use.
Start time.
End time.
Option to preserve original timestamps.
The cancellation token for the operation.
Task{Stream}.
Gets the subtitle language encoding parameter.
The subtitle stream.
The language.
The media source.
The cancellation token.
System.String.
Gets the path to a subtitle file.
The subtitle stream.
The media source.
The cancellation token.
System.String.
Extracts all extractable subtitles (text and pgs).
The mediaSource.
The cancellation token.
Task.
A service for managing media transcoding.
Get transcoding job.
Playback session id.
The transcoding job.
Get transcoding job.
Path to the transcoding file.
The .
The transcoding job.
Ping transcoding job.
Play session id.
Is user paused.
Play session id is null.
Kills the single transcoding job.
The device id.
The play session identifier.
The delete files.
Task.
Report the transcoding progress to the session manager.
The of which the progress will be reported.
The of the current transcoding job.
The current transcoding position.
The framerate of the transcoding job.
The completion percentage of the transcode.
The number of bytes transcoded.
The bitrate of the transcoding job.
Starts FFMpeg.
The state.
The output path.
The command line arguments for FFmpeg.
The user id.
The .
The cancellation token source.
The working directory.
Task.
Called when [transcode begin request].
The path.
The type.
The .
Called when [transcode end].
The transcode job.
Transcoding lock.
The output path of the transcoded file.
The cancellation token.
An .
Class TranscodingJob.
Initializes a new instance of the class.
Instance of the interface.
Gets or sets the play session identifier.
Gets or sets the live stream identifier.
Gets or sets a value indicating whether is live output.
Gets or sets the path.
Gets or sets path.
Gets or sets the type.
Gets or sets the process.
Gets or sets the active request count.
Gets or sets device id.
Gets or sets cancellation token source.
Gets or sets a value indicating whether has exited.
Gets or sets exit code.
Gets or sets a value indicating whether is user paused.
Gets or sets id.
Gets or sets framerate.
Gets or sets completion percentage.
Gets or sets bytes downloaded.
Gets or sets bytes transcoded.
Gets or sets bit rate.
Gets or sets transcoding position ticks.
Gets or sets download position ticks.
Gets or sets transcoding throttler.
Gets or sets transcoding segment cleaner.
Gets or sets last ping date.
Gets or sets ping timeout.
Stop kill timer.
Dispose kill timer.
Start kill timer.
Callback action.
Start kill timer.
Callback action.
Callback interval.
Change kill timer if started.
Stops the transcoding job.
Enum TranscodingJobType.
The progressive.
The HLS.
The dash.
Transcoding segment cleaner.
Initializes a new instance of the class.
Transcoding job dto.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
The segment length of this transcoding job.
Start timer.
Stop cleaner.
Dispose cleaner.
Dispose cleaner.
Disposing.
Transcoding throttler.
Initializes a new instance of the class.
Transcoding job dto.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Start timer.
Unpause transcoding.
A .
Stop throttler.
A .
Dispose throttler.
Dispose throttler.
Disposing.
Defines methods for interacting with media segments.
Uses all segment providers enabled for the 's library to get the Media Segments.
The Item to evaluate.
The library options.
If set, will force to remove existing segments and replace it with new ones otherwise will check for existing segments and if found any that should not be deleted, stops.
The cancellation token.
A task that indicates the Operation is finished.
Returns if this item supports media segments.
The base Item to check.
True if supported otherwise false.
Creates a new Media Segment associated with an Item.
The segment to create.
The id of the Provider who created this segment.
The created Segment entity.
Deletes a single media segment.
The to delete.
a task.
Deletes all media segments of an item.
The to delete all segments for.
The cancellation token.
a task.
Obtains all segments associated with the itemId.
The .
filters all media segments of the given type to be included. If null all types are included.
The library options.
When set filters the segments to only return those that which providers are currently enabled on their library.
An enumerator of 's.
Gets information about any media segments stored for the given itemId.
The id of the .
True if there are any segments stored for the item, otherwise false.
TODO: this should be async but as the only caller BaseItem.GetVersionInfo isn't async, this is also not. Venson.
Gets a list of all registered Segment Providers and their IDs.
The media item that should be tested for providers.
A list of all providers for the tested item.
Provides methods for Obtaining the Media Segments from an Item.
Gets the provider name.
Enumerates all Media Segments from an Media Item.
Arguments to enumerate MediaSegments.
Abort token.
A list of all MediaSegments found from this provider.
Should return support state for the given item.
The base item to extract segments from.
True if item is supported, otherwise false.
The request authorization info.
Gets the user identifier.
The user identifier.
Gets or sets the device identifier.
The device identifier.
Gets or sets the device.
The device.
Gets or sets the client.
The client.
Gets or sets the version.
The version.
Gets or sets the token.
The token.
Gets or sets a value indicating whether the authorization is from an api key.
Gets or sets the user making the request.
Gets or sets a value indicating whether the token is authenticated.
Gets a value indicating whether the request has a token.
Starts sending data over a web socket periodically when a message is received, and then stops when a corresponding stop message is received.
The type of the T return data type.
The type of the T state type.
The _active connections.
The logger.
Gets the type used for the messages sent to the client.
The type.
Gets the message type received from the client to start sending messages.
The type.
Gets the message type received from the client to stop sending messages.
The type.
Gets the data to send.
Task{`1}.
Gets the data to send for a specific connection.
The connection.
Task{`1}.
Processes the message.
The message.
Task.
Starts sending messages over a web socket.
The message.
Stops sending messages over a web socket.
The message.
Disposes the connection.
The connection.
IAuthorization context.
Gets the authorization information.
The request context.
A task containing the authorization info.
Gets the authorization information.
The request context.
A containing the authorization info.
IAuthService.
Authenticate request.
The request.
Authorization information. Null if unauthenticated.
Interface for WebSocket connections.
Occurs when [closed].
Gets the last activity date.
The last activity date.
Gets or sets the date of last Keepalive received.
The date of last Keepalive received.
Gets or sets the receive action.
The receive action.
Gets the state.
The state.
Gets the authorization information.
Gets the remote end point.
The remote end point.
Sends a message asynchronously.
The message.
The cancellation token.
Task.
The message is null.
Sends a message asynchronously.
The type of websocket message data.
The message.
The cancellation token.
Task.
The message is null.
Receives a message asynchronously.
The cancellation token.
Task.
Interface for listening to messages coming through a web socket connection.
Processes the message.
The message.
Task.
Processes a new web socket connection.
An instance of the interface.
The current http context.
Task.
Interface IHttpServer.
The HTTP request handler.
The current HTTP context.
The task.
The exception that is thrown when a user is authenticated, but not authorized to access a requested resource.
Initializes a new instance of the class.
Initializes a new instance of the class.
The message that describes the error.
Initializes a new instance of the class.
The message that describes the error.
The exception that is the cause of the current exception, or a null reference if no inner exception is specified.
Websocket message without data.
Gets or sets the type of the message.
TODO make this abstract and get only.
Gets or sets the server id.
Class WebSocketMessageInfo.
Gets or sets the connection.
The connection.
Class WebSocketMessage.
The type of the data.
Initializes a new instance of the class.
Initializes a new instance of the class.
The data to send.
Gets or sets the data.
Interface representing that the websocket message is inbound.
Activity log entry start message.
Data is the timing data encoded as "$initialDelay,$interval" in ms.
Initializes a new instance of the class.
Data is the timing data encoded as "$initialDelay,$interval" in ms.
The timing data encoded as "$initialDelay,$interval".
Activity log entry stop message.
Keep alive websocket messages.
Scheduled tasks info start message.
Data is the timing data encoded as "$initialDelay,$interval" in ms.
Initializes a new instance of the class.
The timing data encoded as $initialDelay,$interval.
Scheduled tasks info stop message.
Sessions start message.
Data is the timing data encoded as "$initialDelay,$interval" in ms.
Initializes a new instance of the class.
The timing data encoded as $initialDelay,$interval.
Sessions stop message.
Inbound websocket message.
Inbound websocket message with data.
The data type.
Initializes a new instance of the class.
Initializes a new instance of the class.
The data to send.
Interface representing that the websocket message is outbound.
Activity log created message.
Initializes a new instance of the class.
List of activity log entries.
Force keep alive websocket messages.
Initializes a new instance of the class.
The timeout in seconds.
General command websocket message.
Initializes a new instance of the class.
The general command.
Library changed message.
Initializes a new instance of the class.
The library update info.
Keep alive websocket messages.
Play command websocket message.
Initializes a new instance of the class.
The play request.
Playstate message.
Initializes a new instance of the class.
Playstate request data.
Plugin installation cancelled message.
Initializes a new instance of the class.
Installation info.
Plugin installation completed message.
Initializes a new instance of the class.
Installation info.
Plugin installation failed message.
Initializes a new instance of the class.
Installation info.
Package installing message.
Initializes a new instance of the class.
Installation info.
Plugin uninstalled message.
Initializes a new instance of the class.
Plugin info.
Refresh progress message.
Initializes a new instance of the class.
Refresh progress data.
Restart required.
Scheduled task ended message.
Initializes a new instance of the class.
Task result.
Scheduled tasks info message.
Initializes a new instance of the class.
List of task infos.
Series timer cancelled message.
Initializes a new instance of the class.
The timer event info.
Series timer created message.
Initializes a new instance of the class.
timer event info.
Server restarting down message.
Server shutting down message.
Sessions message.
Initializes a new instance of the class.
Session info.
Sync play command.
Initializes a new instance of the class.
The send command.
Timer cancelled message.
Initializes a new instance of the class.
Timer event info.
Timer created message.
Initializes a new instance of the class.
Timer event info.
User data changed message.
Initializes a new instance of the class.
The data change info.
User deleted message.
Initializes a new instance of the class.
The user id.
User updated message.
Initializes a new instance of the class.
The user dto.
Outbound websocket message.
Gets or sets the message id.
Outbound websocket message with data.
The data type.
Initializes a new instance of the class.
Initializes a new instance of the class.
The data to send.
Gets or sets the message id.
Interface IChapterRepository.
Deletes the chapters.
The item.
The cancellation token.
Task.
Saves the chapters.
The item.
The set of chapters.
Gets all chapters associated with the baseItem.
The BaseItems id.
A readonly list of chapter instances.
Gets a single chapter of a BaseItem on a specific index.
The BaseItems id.
The index of that chapter.
A chapter instance.
Provides an interface to implement an Item repository.
Deletes the item.
The identifier to delete.
Saves the items.
The items.
The cancellation token.
Reattaches the user data to the item.
The item.
The cancellation token.
A task that represents the asynchronous reattachment operation.
Retrieves the item.
The id.
BaseItem.
Gets the items.
The query.
QueryResult<BaseItem>.
Gets the item ids list.
The query.
List<Guid>.
Gets the item list.
The query.
List<BaseItem>.
Gets the item list. Used mainly by the Latest api endpoint.
The query.
Collection Type.
List<BaseItem>.
Gets the list of series presentation keys for next up.
The query.
The minimum date for a series to have been most recently watched.
The list of keys.
Updates the inherited values.
Checks if an item has been persisted to the database.
The id to check.
True if the item exists, otherwise false.
Gets a value indicating wherever all children of the requested Id has been played.
The userdata to check against.
The Top id to check.
Whever the check should be done recursive. Warning expensive operation.
A value indicating whever all children has been played.
Gets all artist matches from the db.
The names of the artists.
A map of the artist name and the potential matches.
Provides static lookup data for and for the domain.
Gets all serialisation target types for music related kinds.
Gets mapping for all BaseItemKinds and their expected serialization target.
Provides methods for accessing keyframe data.
Gets the keyframe data.
The item id.
The keyframe data.
Saves the keyframe data.
The item id.
The keyframe data.
The cancellation token.
The task object representing the asynchronous operation.
Deletes the keyframe data.
The item id.
The cancellation token.
The task object representing the asynchronous operation.
Gets the media attachments.
The query.
IEnumerable{MediaAttachment}.
Saves the media attachments.
The identifier.
The attachments.
The cancellation token.
Provides methods for accessing MediaStreams.
Gets the media streams.
The query.
IEnumerable{MediaStream}.
Saves the media streams.
The identifier.
The streams.
The cancellation token.
Gets the people.
The query.
The list of people matching the filter.
Updates the people.
The item identifier.
The people.
Gets the people names.
The query.
The list of people names matching the filter.
Gets or sets the index.
The index.
Gets or sets the item identifier.
The item identifier.
Gets or sets the type.
The type.
Gets or sets the index.
The index.
Gets or sets the item identifier.
The item identifier.
Gets the playlist.
The playlist identifier.
The user identifier.
Playlist.
Creates the playlist.
The .
The created playlist.
Updates a playlist.
The .
Task.
Gets all playlists a user has access to.
The user identifier.
IEnumerable<Playlist>.
Adds a share to the playlist.
The .
Task.
Removes a share from the playlist.
The playlist identifier.
The user identifier.
The share.
Task.
Adds to playlist.
The playlist identifier.
The item ids.
The user identifier.
Task.
Removes from playlist.
The playlist identifier.
The entry ids.
Task.
Gets the playlists folder.
Folder.
Gets the playlists folder for a user.
The user identifier.
Folder.
Moves the item.
The playlist identifier.
The entry identifier.
The new index.
The calling user.
Task.
Removed all playlists of a user.
If the playlist is shared, ownership is transferred.
The user id.
Task.
Saves a playlist.
The playlist.
Defines the .
This interface is only used for service registration and requires a parameterless constructor.
Registers the plugin's services with the service collection.
The service collection.
The server application host.
Gets or sets the album artist.
The album artist.
Gets or sets the artist provider ids.
The artist provider ids.
Fetches the metadata asynchronously.
The item.
The .
The .
A fetching the .
Gets the supported images.
The item.
IEnumerable{ImageType}.
Gets the image.
The item.
The type.
The cancellation token.
Task{DynamicImageResponse}.
Represents an identifier for an external provider.
Gets the display name of the provider associated with this ID type.
Gets the unique key to distinguish this provider/type pair. This should be unique across providers.
Gets the specific media type for this id. This is used to distinguish between the different
external id types for providers with multiple ids.
A null value indicates there is no specific media type associated with the external id, or this is the
default id for the external provider so there is no need to specify a type.
This can be used along with the to localize the external id on the client.
Determines whether this id supports a given item type.
The item.
True if this item is supported, otherwise false.
Interface to include related urls for an item.
Gets the external service name.
Get the list of external urls.
The item to get external urls for.
The list of external urls.
This is a marker interface that will cause a provider to run even if an item is locked from changes.
Determines whether the specified item has changed.
The item.
The directory service.
true if the specified item has changed; otherwise, false.
Interface IHasOrder.
Gets the order.
The order.
Interface IImageProvider.
Gets the name.
The name.
Supports the specified item.
The item.
true if the provider supports the item.
This is just a marker interface.
Gets the metadata.
The information.
The directory service.
The cancellation token.
Task{MetadataResult{0}}.
Gets or sets a value indicating whether old metadata should be removed if it isn't replaced.
Marker interface.
Gets the name.
The name.
Gets the order.
The order.
Determines whether this instance can refresh the specified item.
The item.
true if this instance can refresh the specified item.
Determines whether this instance primarily targets the specified type.
The type.
true if this instance primarily targets the specified type.
Refreshes the metadata.
The item.
The options.
The cancellation token.
Task.
Interface IProviderManager.
Queues the refresh.
Item ID.
MetadataRefreshOptions for operation.
RefreshPriority for operation.
Refreshes the full item.
The item.
The options.
The cancellation token.
Task.
Refreshes the metadata.
The item.
The options.
The cancellation token.
Task.
Saves the image.
The item.
The URL.
The type.
Index of the image.
The cancellation token.
Task.
Saves the image.
The item.
The source.
Type of the MIME.
The type.
Index of the image.
The cancellation token.
Task.
Saves the image by giving the image path on filesystem.
This method will remove the image on the source path after saving it to the destination.
Image to save.
Source of image.
Mime type image.
Type of image.
Index of image.
Option to save locally.
CancellationToken to use with operation.
Task.
Adds the metadata providers.
Image providers to use.
Metadata services to use.
Metadata providers to use.
Metadata savers to use.
External IDs to use.
The list of external url providers.
Gets the available remote images.
The item.
The query.
The cancellation token.
Task{IEnumerable{RemoteImageInfo}}.
Gets the image providers.
The item.
IEnumerable{ImageProviderInfo}.
Gets the image providers for the provided item.
The item.
The image refresh options.
The image providers for the item.
Gets the metadata providers for the provided item.
The item.
The library options.
The type of metadata provider.
The metadata providers.
Gets the metadata savers for the provided item.
The item.
The library options.
The metadata savers.
Gets all metadata plugins.
IEnumerable{MetadataPlugin}.
Gets the external urls.
The item.
IEnumerable{ExternalUrl}.
Gets the external identifier infos.
The item.
IEnumerable{ExternalIdInfo}.
Saves the metadata.
The item.
Type of the update.
The task object representing the asynchronous operation.
Saves the metadata.
The item.
Type of the update.
The metadata savers.
The task object representing the asynchronous operation.
Gets the metadata options.
The item.
MetadataOptions.
Gets the remote search results.
The type of the t item type.
The type of the t lookup type.
The search information.
The cancellation token.
Task{IEnumerable{SearchResult{``1}}}.
Interface IImageProvider.
Gets the supported images.
The item.
IEnumerable{ImageType}.
Gets the images.
The item.
The cancellation token.
Task{IEnumerable{RemoteImageInfo}}.
Gets the image response.
The URL.
The cancellation token.
Task{HttpResponseInfo}.
Interface IRemoteMetadataProvider.
Interface IRemoteMetadataProvider.
The type of .
The type of .
Gets the metadata for a specific LookupInfoType.
The LookupInfoType to get metadata for.
The .
A task returning a MetadataResult for the specific LookupInfoType.
Interface IRemoteMetadataProvider.
The type of .
Gets the list of for a specific LookupInfoType.
The LookupInfoType to search for.
The .
A task returning RemoteSearchResults for the searchInfo.
Gets the image response.
The URL.
The cancellation token.
Task{HttpResponseInfo}.
Gets or sets the name.
The name.
Gets or sets the original title.
The original title of the item.
Gets or sets the path.
The path.
Gets or sets the metadata language.
The metadata language.
Gets or sets the metadata country code.
The metadata country code.
Gets or sets the provider ids.
The provider ids.
Gets or sets the year.
The year.
The none.
The validation only.
Providers will be executed based on default rules.
All providers will be executed to search for new metadata.
Gets or sets a value indicating whether all existing data should be overwritten with new data from providers
when paired with MetadataRefreshMode=FullRefresh.
Gets or sets a value indicating whether all existing trickplay images should be overwritten
when paired with MetadataRefreshMode=FullRefresh.
Not only does this clear, but initializes the list so that services can differentiate between a null list and zero people.
Provider refresh priority.
High priority.
Normal priority.
Low priority.
Gets or sets the provider name to search within if set.
Gets or sets a value indicating whether disabled providers should be included.
true if disabled providers should be included.
Enum VideoContentType.
The episode.
The movie.
Quick connect standard interface.
Gets a value indicating whether quick connect is enabled or not.
Initiates a new quick connect request.
The initiator authorization info.
A quick connect result with tokens to proceed or throws an exception if not active.
Checks the status of an individual request.
Unique secret identifier of the request.
Quick connect result.
Authorizes a quick connect request to connect as the calling user.
User id.
Identifying code for the request.
A boolean indicating if the authorization completed successfully.
Gets the authorized request for the secret.
The secret.
The authentication result.
Interface IItemResolver.
Gets the priority.
The priority.
Resolves the path.
The args.
BaseItem.
Provides a base "rule" that anyone can use to have paths ignored by the resolver.
Checks whether or not the file should be ignored.
The file information.
The parent BaseItem.
True if the file should be ignored.
Class ItemResolver.
The type of BaseItem.
Gets the priority.
The priority.
Resolves the specified args.
The args.
`0.
Sets initial values on the newly resolved item.
The item.
The args.
Resolves the path.
The args.
BaseItem.
Enum ResolverPriority.
The highest priority. Used by plugins to bypass the default server resolvers.
The first.
The second.
The third.
The Fourth.
The Fifth.
The last.
Gets or sets the identifier.
The identifier.
Gets or sets the access token.
The access token.
Gets or sets the device identifier.
The device identifier.
Gets or sets the name of the application.
The name of the application.
Gets or sets the application version.
The application version.
Gets or sets the name of the device.
The name of the device.
Gets or sets the user identifier.
The user identifier.
Gets or sets a value indicating whether this instance is active.
true if this instance is active; otherwise, false.
Gets or sets the date created.
The date created.
Gets or sets the date revoked.
The date revoked.
Handles the retrieval and storage of API keys.
Creates an API key.
The name of the key.
A task representing the creation of the key.
Gets the API keys.
A task representing the retrieval of the API keys.
Deletes an API key with the provided access token.
The access token.
A task representing the deletion of the API key.
Gets a value indicating whether this instance is session active.
true if this instance is session active; otherwise, false.
Gets a value indicating whether [supports media remote control].
true if [supports media remote control]; otherwise, false.
Sends the message.
The type of data.
Name of message type.
Message ID.
Data to send.
CancellationToken for operation.
A task.
Interface ISessionManager.
Occurs when [playback start].
Occurs when [playback progress].
Occurs when [playback stopped].
Occurs when [session started].
Occurs when [session ended].
Occurs when [session controller connected].
Occurs when [capabilities changed].
Gets the sessions.
The sessions.
Logs the user activity.
Type of the client.
The app version.
The device id.
Name of the device.
The remote end point.
The user.
A task containing the session information.
Used to report that a session controller has connected.
The session.
Used to report that playback has started for an item.
The info.
Task.
Used to report playback progress for an item.
The info.
Task.
Throws if an argument is null.
Used to report that playback has ended for an item.
The info.
Task.
Throws if an argument is null.
Reports the session ended.
The session identifier.
Task.
Sends the general command.
The controlling session identifier.
The session identifier.
The command.
The cancellation token.
Task.
Sends the message command.
The controlling session identifier.
The session id.
The command.
The cancellation token.
Task.
Sends the play command.
The controlling session identifier.
The session id.
The command.
The cancellation token.
Task.
Sends a SyncPlayCommand to a session.
The identifier of the session.
The command.
The cancellation token.
Task.
Sends a SyncPlayGroupUpdate to a session.
The identifier of the session.
The group update.
The cancellation token.
The group update type.
Task.
Sends the browse command.
The controlling session identifier.
The session id.
The command.
The cancellation token.
Task.
Sends the playstate command.
The controlling session identifier.
The session id.
The command.
The cancellation token.
Task.
Sends the message to admin sessions.
Type of data.
Message type name.
The data.
The cancellation token.
Task.
Sends the message to user sessions.
Type of data.
Users to send messages to.
Message type name.
The data.
The cancellation token.
Task.
Sends the message to user sessions.
Type of data.
Users to send messages to.
Message type name.
Data function.
The cancellation token.
Task.
Sends the message to user device sessions.
Type of data.
The device identifier.
Message type name.
The data.
The cancellation token.
Task.
Sends the restart required message.
The cancellation token.
Task.
Adds the additional user.
The session identifier.
The user identifier.
Removes the additional user.
The session identifier.
The user identifier.
Reports the now viewing item.
The session identifier.
The item identifier.
Authenticates the new session.
The request.
Task{SessionInfo}.
Reports the capabilities.
The session identifier.
The capabilities.
Reports the transcoding information.
The device identifier.
The information.
Clears the transcoding information.
The device identifier.
Gets the session.
The device identifier.
The client.
The version.
SessionInfo.
Gets all sessions available to a user.
The session identifier.
The device id.
Active within session limit.
Filter for sessions remote controllable for this user.
Is the request authenticated with API key.
IReadOnlyList{SessionInfoDto}.
Gets the session by authentication token.
The token.
The device identifier.
The remote endpoint.
SessionInfo.
Gets the session by authentication token.
The information.
The device identifier.
The remote endpoint.
The application version.
Task<SessionInfo>.
Logs out the specified access token.
The access token.
A representing the log out process.
Revokes the user tokens.
The user's id.
The current access token.
Task.
Used to close the livestream if needed.
The livestream id.
The session id or playsession id.
Task.
Gets the dto for session info.
The session info.
of the session.
Class SessionInfo.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Gets or sets the play state.
The play state.
Gets or sets the additional users.
The additional users.
Gets or sets the client capabilities.
The client capabilities.
Gets or sets the remote end point.
The remote end point.
Gets the playable media types.
The playable media types.
Gets or sets the id.
The id.
Gets or sets the user id.
The user id.
Gets or sets the username.
The username.
Gets or sets the type of the client.
The type of the client.
Gets or sets the last activity date.
The last activity date.
Gets or sets the last playback check in.
The last playback check in.
Gets or sets the last paused date.
The last paused date.
Gets or sets the name of the device.
The name of the device.
Gets or sets the type of the device.
The type of the device.
Gets or sets the now playing item.
The now playing item.
Gets or sets the now playing queue full items.
The now playing queue full items.
Gets or sets the now viewing item.
The now viewing item.
Gets or sets the device id.
The device id.
Gets or sets the application version.
The application version.
Gets or sets the session controller.
The session controller.
Gets or sets the transcoding info.
The transcoding info.
Gets a value indicating whether this instance is active.
true if this instance is active; otherwise, false.
Gets a value indicating whether the session supports media control.
true if this session supports media control; otherwise, false.
Gets a value indicating whether the session supports remote control.
true if this session supports remote control; otherwise, false.
Gets or sets the now playing queue.
The now playing queue.
Gets or sets the now playing queue full items.
The now playing queue full items.
Gets or sets a value indicating whether the session has a custom device name.
true if this session has a custom device name; otherwise, false.
Gets or sets the playlist item id.
The playlist item id.
Gets or sets the server id.
The server id.
Gets or sets the user primary image tag.
The user primary image tag.
Gets the supported commands.
The supported commands.
Ensures a controller of type exists.
Class to register.
The factory.
Tuple{ISessionController, bool}.
Adds a controller to the session.
The controller.
Gets a value indicating whether the session contains a user.
The user id to check.
true if this session contains the user; otherwise, false.
Starts automatic progressing.
The playback progress info.
The supported commands.
Stops automatic progressing.
Disposes the instance async.
ValueTask.
Interface IBaseItemComparer.
Gets the comparer type.
Represents a BaseItem comparer that requires a User to perform its comparison.
Gets or sets the user.
The user.
Gets or sets the user manager.
The user manager.
Gets or sets the user data repository.
The user data repository.
A progressive file stream for transferring transcoded files as they are written to.
Initializes a new instance of the class.
The path to the transcoded file.
The transcoding job information.
The transcode manager.
The timeout duration in milliseconds.
Initializes a new instance of the class.
The stream to progressively copy.
The timeout duration in milliseconds.
The audio streaming request dto.
Gets or sets the params.
Gets or sets the play session id.
Gets or sets the tag.
Gets or sets the segment container.
Gets or sets the segment length.
Gets or sets the min segments.
Gets or sets the position of the requested segment in ticks.
Gets or sets the actual segment length in ticks.
The stream state dto.
Initializes a new instance of the class.
Instance of the interface.
The .
The singleton.
Gets or sets the requested url.
Gets or sets the request.
Gets the video request.
Gets or sets the direct stream provider.
Deprecated.
Gets or sets the path to wait for.
Gets a value indicating whether the request outputs video.
Gets the segment length.
Gets the minimum number of segments.
Gets or sets the user agent.
Gets or sets a value indicating whether to estimate the content length.
Gets or sets the transcode seek info.
Gets or sets the transcoding job.
Disposes the stream state.
Whether the object is currently being disposed.
The video request dto.
Gets a value indicating whether this instance has fixed resolution.
true if this instance has fixed resolution; otherwise, false.
Gets or sets a value indicating whether to enable subtitles in the manifest.
Gets or sets a value indicating whether to enable trickplay images.
Occurs when [subtitle download failure].
Searches the subtitles.
The video.
Subtitle language.
Require perfect match.
Request is automated.
CancellationToken to use for the operation.
Subtitles, wrapped in task.
Searches the subtitles.
The request.
The cancellation token.
Task{RemoteSubtitleInfo[]}.
Downloads the subtitles.
The video.
Subtitle ID.
CancellationToken to use for the operation.
A task.
Downloads the subtitles.
The video.
Library options to use.
Subtitle ID.
CancellationToken to use for the operation.
A task.
Upload new subtitle.
The video the subtitle belongs to.
The subtitle response.
A representing the asynchronous operation.
Gets the remote subtitles.
The identifier.
The cancellation token.
.
Deletes the subtitles.
Media item.
Subtitle index.
A task.
Gets the providers.
The media item.
Subtitles providers.
Gets the name.
The name.
Gets the supported media types.
The supported media types.
Searches the subtitles.
The request.
The cancellation token.
Task{IEnumerable{RemoteSubtitleInfo}}.
Gets the subtitles.
The identifier.
The cancellation token.
Task{SubtitleResponse}.
An event that occurs when subtitle downloading fails.
Gets or sets the item.
Gets or sets the provider.
Gets or sets the exception.
Class GroupMember.
Initializes a new instance of the class.
The session.
Gets the identifier of the session.
The session identifier.
Gets the identifier of the user.
The user identifier.
Gets the username.
The username.
Gets or sets the ping, in milliseconds.
The ping.
Gets or sets a value indicating whether this member is buffering.
true if member is buffering; false otherwise.
Gets or sets a value indicating whether this member is following group playback.
true to ignore member on group wait; false if they're following group playback.
Class AbstractGroupState.
Class is not thread-safe, external locking is required when accessing methods.
The logger.
Initializes a new instance of the class.
Instance of the interface.
Gets the logger factory.
Sends a group state update to all group.
The context of the state.
The reason of the state change.
The session.
The cancellation token.
Class IdleGroupState.
Class is not thread-safe, external locking is required when accessing methods.
The logger.
Initializes a new instance of the class.
Instance of the interface.
Class PausedGroupState.
Class is not thread-safe, external locking is required when accessing methods.
Initializes a new instance of the class.
Instance of the interface.
Class PlayingGroupState.
Class is not thread-safe, external locking is required when accessing methods.
Initializes a new instance of the class.
Instance of the interface.
Gets or sets a value indicating whether requests for buffering should be ignored.
Class WaitingGroupState.
Class is not thread-safe, external locking is required when accessing methods.
The logger.
Initializes a new instance of the class.
Instance of the interface.
Gets or sets a value indicating whether playback should resume when group is ready.
Gets or sets a value indicating whether the initial state has been set.
Gets or sets the group state before the first ever event.
Interface IGroupPlaybackRequest.
Gets the playback request type.
The playback request type.
Applies the request to a group.
The context of the state.
The current state.
The session.
The cancellation token.
Interface IGroupState.
Gets the group state type.
The group state type.
Handles a session that joined the group.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a session that is leaving the group.
The context of the state.
The previous state.
The session.
The cancellation token.
Generic handler. Context's state can change.
The generic request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a play request from a session. Context's state can change.
The play request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a set-playlist-item request from a session. Context's state can change.
The set-playlist-item request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a remove-items request from a session. Context's state can change.
The remove-items request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a move-playlist-item request from a session. Context's state should not change.
The move-playlist-item request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a queue request from a session. Context's state should not change.
The queue request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles an unpause request from a session. Context's state can change.
The unpause request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a pause request from a session. Context's state can change.
The pause request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a stop request from a session. Context's state can change.
The stop request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a seek request from a session. Context's state can change.
The seek request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a buffer request from a session. Context's state can change.
The buffer request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a ready request from a session. Context's state can change.
The ready request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a next-item request from a session. Context's state can change.
The next-item request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a previous-item request from a session. Context's state can change.
The previous-item request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a set-repeat-mode request from a session. Context's state should not change.
The repeat-mode request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a set-shuffle-mode request from a session. Context's state should not change.
The shuffle-mode request.
The context of the state.
The previous state.
The session.
The cancellation token.
Updates the ping of a session. Context's state should not change.
The ping request.
The context of the state.
The previous state.
The session.
The cancellation token.
Handles a ignore-wait request from a session. Context's state can change.
The ignore-wait request.
The context of the state.
The previous state.
The session.
The cancellation token.
Interface IGroupStateContext.
Gets the default ping value used for sessions, in milliseconds.
The default ping value used for sessions, in milliseconds.
Gets the maximum time offset error accepted for dates reported by clients, in milliseconds.
The maximum offset error accepted, in milliseconds.
Gets the maximum offset error accepted for position reported by clients, in milliseconds.
The maximum offset error accepted, in milliseconds.
Gets the group identifier.
The group identifier.
Gets or sets the position ticks.
The position ticks.
Gets or sets the last activity.
The last activity.
Gets the play queue.
The play queue.
Sets a new state.
The new state.
Sends a GroupUpdate message to the interested sessions.
The current session.
The filtering type.
The message to send.
The cancellation token.
The group update type.
The task.
Sends a playback command to the interested sessions.
The current session.
The filtering type.
The message to send.
The cancellation token.
The task.
Builds a new playback command with some default values.
The command type.
The command.
Sanitizes the PositionTicks, considers the current playing item when available.
The PositionTicks.
The sanitized position ticks.
Updates the ping of a session, in milliseconds.
The session.
The ping, in milliseconds.
Gets the highest ping in the group, in milliseconds.
The highest ping in the group.
Sets the session's buffering state.
The session.
The state.
Sets the buffering state of all the sessions.
The state.
Gets the group buffering state.
true if there is a session buffering in the group; false otherwise.
Sets the session's group wait state.
The session.
The state.
Sets a new play queue.
The new play queue.
The playing item position in the play queue.
The start position ticks.
true if the play queue has been changed; false if something went wrong.
Sets the playing item.
The new playing item identifier.
true if the play queue has been changed; false if something went wrong.
Clears the play queue.
Whether to remove the playing item as well.
Removes items from the play queue.
The items to remove.
true if playing item got removed; false otherwise.
Moves an item in the play queue.
The playlist identifier of the item to move.
The new position.
true if item has been moved; false if something went wrong.
Updates the play queue.
The new items to add to the play queue.
The mode with which the items will be added.
true if the play queue has been changed; false if something went wrong.
Restarts current item in play queue.
Picks next item in play queue.
true if the item changed; false otherwise.
Picks previous item in play queue.
true if the item changed; false otherwise.
Sets the repeat mode.
The new mode.
Sets the shuffle mode.
The new mode.
Creates a play queue update.
The reason for the update.
The play queue update.
Interface ISyncPlayManager.
Creates a new group.
The session that's creating the group.
The request.
The cancellation token.
The newly created group.
Adds the session to a group.
The session.
The request.
The cancellation token.
Removes the session from a group.
The session.
The request.
The cancellation token.
Gets list of available groups for a session.
The session.
The request.
The list of available groups.
Gets available groups for a session by id.
The session.
The group id.
The groups or null.
Handle a request by a session in a group.
The session.
The request.
The cancellation token.
Checks whether a user has an active session using SyncPlay.
The user identifier to check.
true if the user is using SyncPlay; false otherwise.
Interface ISyncPlayRequest.
Gets the request type.
The request type.
Class AbstractPlaybackRequest.
Initializes a new instance of the class.
Class BufferGroupRequest.
Initializes a new instance of the class.
When the request has been made, as reported by the client.
The position ticks.
Whether the client playback is unpaused.
The playlist item identifier of the playing item.
Gets when the request has been made by the client.
The date of the request.
Gets the position ticks.
The position ticks.
Gets a value indicating whether the client playback is unpaused.
The client playback status.
Gets the playlist item identifier of the playing item.
The playlist item identifier.
Class IgnoreWaitGroupRequest.
Initializes a new instance of the class.
Whether the client should be ignored.
Gets a value indicating whether the client should be ignored.
The client group-wait status.
Class MovePlaylistItemGroupRequest.
Initializes a new instance of the class.
The playlist identifier of the item.
The new position.
Gets the playlist identifier of the item.
The playlist identifier of the item.
Gets the new position.
The new position.
Class NextItemGroupRequest.
Initializes a new instance of the class.
The playing item identifier.
Gets the playing item identifier.
The playing item identifier.
Class PauseGroupRequest.
Class PingGroupRequest.
Initializes a new instance of the class.
The ping time.
Gets the ping time.
The ping time.
Class PlayGroupRequest.
Initializes a new instance of the class.
The playing queue.
The playing item position.
The start position ticks.
Gets the playing queue.
The playing queue.
Gets the position of the playing item in the queue.
The playing item position.
Gets the start position ticks.
The start position ticks.
Class PreviousItemGroupRequest.
Initializes a new instance of the class.
The playing item identifier.
Gets the playing item identifier.
The playing item identifier.
Class QueueGroupRequest.
Initializes a new instance of the class.
The items to add to the queue.
The enqueue mode.
Gets the items to enqueue.
The items to enqueue.
Gets the mode in which to add the new items.
The enqueue mode.
Class ReadyGroupRequest.
Initializes a new instance of the class.
When the request has been made, as reported by the client.
The position ticks.
Whether the client playback is unpaused.
The playlist item identifier of the playing item.
Gets when the request has been made by the client.
The date of the request.
Gets the position ticks.
The position ticks.
Gets a value indicating whether the client playback is unpaused.
The client playback status.
Gets the playlist item identifier of the playing item.
The playlist item identifier.
Class RemoveFromPlaylistGroupRequest.
Initializes a new instance of the class.
The playlist ids of the items to remove.
Whether to clear the entire playlist. The items list will be ignored.
Whether to remove the playing item as well. Used only when clearing the playlist.
Gets the playlist identifiers of the items.
The playlist identifiers of the items.
Gets a value indicating whether the entire playlist should be cleared.
Whether the entire playlist should be cleared.
Gets a value indicating whether the playing item should be removed as well.
Whether the playing item should be removed as well.
Class SeekGroupRequest.
Initializes a new instance of the class.
The position ticks.
Gets the position ticks.
The position ticks.
Class SetPlaylistItemGroupRequest.
Initializes a new instance of the class.
The playlist identifier of the item.
Gets the playlist identifier of the playing item.
The playlist identifier of the playing item.
Class SetRepeatModeGroupRequest.
Initializes a new instance of the class.
The repeat mode.
Gets the repeat mode.
The repeat mode.
Class SetShuffleModeGroupRequest.
Initializes a new instance of the class.
The shuffle mode.
Gets the shuffle mode.
The shuffle mode.
Class StopGroupRequest.
Class UnpauseGroupRequest.
Class PlayQueueManager.
Placeholder index for when no item is playing.
The no-playing item index.
The sorted playlist.
The sorted playlist, or play queue of the group.
The shuffled playlist.
The shuffled playlist, or play queue of the group.
Initializes a new instance of the class.
Gets the playing item index.
The playing item index.
Gets the last time the queue has been changed.
The last time the queue has been changed.
Gets the shuffle mode.
The shuffle mode.
Gets the repeat mode.
The repeat mode.
Checks if an item is playing.
true if an item is playing; false otherwise.
Gets the current playlist considering the shuffle mode.
The playlist.
Sets a new playlist. Playing item is reset.
The new items of the playlist.
Appends new items to the playlist. The specified order is maintained.
The items to add to the playlist.
Shuffles the playlist. Shuffle mode is changed. The playlist gets re-shuffled if already shuffled.
Resets the playlist to sorted mode. Shuffle mode is changed.
Clears the playlist. Shuffle mode is preserved.
Whether to remove the playing item as well.
Adds new items to the playlist right after the playing item. The specified order is maintained.
The items to add to the playlist.
Gets playlist identifier of the playing item, if any.
The playlist identifier of the playing item.
Gets the playing item identifier, if any.
The playing item identifier.
Sets the playing item using its identifier. If not in the playlist, the playing item is reset.
The new playing item identifier.
Sets the playing item using its playlist identifier. If not in the playlist, the playing item is reset.
The new playing item identifier.
true if playing item has been set; false if item is not in the playlist.
Sets the playing item using its position. If not in range, the playing item is reset.
The new playing item index.
Removes items from the playlist. If not removed, the playing item is preserved.
The items to remove.
true if playing item got removed; false otherwise.
Moves an item in the playlist to another position.
The item to move.
The new position.
true if the item has been moved; false otherwise.
Resets the playlist to its initial state.
Sets the repeat mode.
The new mode.
Sets the shuffle mode.
The new mode.
Toggles the shuffle mode between sorted and shuffled.
Gets the next item in the playlist considering repeat mode and shuffle mode.
The next item in the playlist.
Sets the next item in the queue as playing item.
true if the playing item changed; false otherwise.
Sets the previous item in the queue as playing item.
true if the playing item changed; false otherwise.
Creates a list from the array of items. Each item is given an unique playlist identifier.
The list of queue items.
Gets the current playlist considering the shuffle mode.
The playlist.
Gets the current playing item, depending on the shuffle mode.
The playing item.
Class JoinGroupRequest.
Initializes a new instance of the class.
The identifier of the group to join.
Gets the group identifier.
The identifier of the group to join.
Class LeaveGroupRequest.
Class ListGroupsRequest.
Class NewGroupRequest.
Initializes a new instance of the class.
The name of the new group.
Gets the group name.
The name of the new group.
Manifest type for backups internal structure.
Gets or sets the jellyfin version this backup was created with.
Gets or sets the backup engine version this backup was created with.
Gets or sets the date this backup was created with.
Gets or sets the path to the backup on the system.
Gets or sets the contents of the backup archive.
Defines the optional contents of the backup archive.
Gets or sets a value indicating whether the archive contains the Metadata contents.
Gets or sets a value indicating whether the archive contains the Trickplay contents.
Gets or sets a value indicating whether the archive contains the Subtitle contents.
Gets or sets a value indicating whether the archive contains the Database contents.
Defines properties used to start a restore process.
Gets or Sets the name of the backup archive to restore from. Must be present in .
Interface ITrickplayManager.
Generates new trickplay images and metadata.
The video.
Whether or not existing data should be replaced.
The library options.
CancellationToken to use for operation.
Task.
Creates trickplay tiles out of individual thumbnails.
Ordered file paths of the thumbnails to be used.
The width of a single thumbnail.
The trickplay options.
The output directory.
The associated trickplay information.
The output directory will be DELETED and replaced if it already exists.
Get available trickplay resolutions and corresponding info.
The item.
Map of width resolutions to trickplay tiles info.
Gets the item ids of all items with trickplay info.
The limit of items to return.
The offset to start the query at.
The list of item ids that have trickplay info.
Saves trickplay info.
The trickplay info.
Task.
Deletes all trickplay info for an item.
The item id.
The cancellation token.
Task.
Gets all trickplay infos for all media streams of an item.
The item.
A map of media source id to a map of tile width to trickplay info.
Gets the path to a trickplay tile image.
The item.
The width of a single thumbnail.
The tile's index.
Whether or not the tile should be saved next to the media file.
The absolute path.
Gets the path to a trickplay tile image.
The item.
The amount of images for the tile width.
The amount of images for the tile height.
The width of a single thumbnail.
Whether or not the tile should be saved next to the media file.
The absolute path.
Migrates trickplay images between local and media directories.
The video.
The library options.
CancellationToken to use for operation.
Task.
Gets the trickplay HLS playlist.
The item.
The width of a single thumbnail.
Optional api key of the requesting user.
The text content of the .m3u8 playlist.
The TV Series manager.
Gets the next up.
The next up query.
The dto options.
The next up items.
Gets the next up.
The next up request.
The list of parent folders.
The dto options.
The next up items.
Defines an interface to restore and backup the jellyfin system.
Creates a new Backup zip file containing the current state of the application.
The backup options.
A task.
Gets a list of backups that are available to be restored from.
A list of backup paths.
Gets a single backup manifest if the path defines a valid Jellyfin backup archive.
The path to be loaded.
The containing backup manifest or null if not existing or compatiable.
Restores an backup zip file created by jellyfin.
Path to the archive.
A Task.
Thrown when an invalid or missing file is specified.
Thrown when attempt to load an unsupported backup is made.
Thrown for errors during the restore.
Schedules a Restore and restarts the server.
The path to the archive to restore from.
Custom -derived type for the ContainerValidationRegex method.
Cached, thread-safe singleton instance.
Initializes the instance.
Provides a factory for creating instances to be used by methods on .
Creates an instance of a used by methods on .
Provides the runner that contains the custom logic implementing the specified regular expression.
Scan the starting from base.runtextstart for the next match.
The text being scanned by the regular expression.
Search starting from base.runtextpos for the next location a match could possibly start.
The text being scanned by the regular expression.
true if a possible match was found; false if no more matches are possible.
Determine whether at base.runtextpos is a match for the regular expression.
The text being scanned by the regular expression.
true if the regular expression matches at the current position; otherwise, false.
Custom -derived type for the WhiteSpaceRegex method.
Cached, thread-safe singleton instance.
Initializes the instance.
Provides a factory for creating instances to be used by methods on .
Creates an instance of a used by methods on .
Provides the runner that contains the custom logic implementing the specified regular expression.
Scan the starting from base.runtextstart for the next match.
The text being scanned by the regular expression.
Search starting from base.runtextpos for the next location a match could possibly start.
The text being scanned by the regular expression.
true if a possible match was found; false if no more matches are possible.
Determine whether at base.runtextpos is a match for the regular expression.
The text being scanned by the regular expression.
true if the regular expression matches at the current position; otherwise, false.
Helper methods used by generated -derived implementations.
Default timeout value set in , or if none was set.
Whether is non-infinite.
Supports searching for characters in or not in "\t\n\v\f\r \u0085 \u2028\u2029 ".