Jellyfin.Api
Internal produces image attribute.
Initializes a new instance of the class.
Content types this endpoint produces.
Gets the configured content types.
the configured content types.
Produces file attribute of "image/*".
Initializes a new instance of the class.
Attribute to mark a parameter as obsolete.
Produces file attribute of "image/*".
Initializes a new instance of the class.
Internal produces image attribute.
Initializes a new instance of the class.
Content types this endpoint produces.
Gets the configured content types.
the configured content types.
Produces file attribute of "image/*".
Initializes a new instance of the class.
Produces file attribute of "image/*".
Initializes a new instance of the class.
Produces file attribute of "video/*".
Initializes a new instance of the class.
LAN access handler. Allows anonymous users.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
The local network authorization requirement. Allows anonymous users.
Custom authentication handler wrapping the legacy authentication.
Initializes a new instance of the class.
The jellyfin authentication service.
Options monitor.
The logger.
The url encoder.
Default authorization handler.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
The default authorization requirement.
Initializes a new instance of the class.
A value indicating whether to validate parental schedule.
Gets a value indicating whether to ignore parental schedule.
Authorization handler for requiring first time setup or default privileges.
Initializes a new instance of the class.
Instance of the interface.
The authorization requirement, requiring incomplete first time setup or default privileges, for the authorization handler.
Initializes a new instance of the class.
A value indicating whether to ignore parental schedule.
A value indicating whether administrator role is required.
Gets a value indicating whether administrator role is required.
Local access or require elevated privileges handler.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
The local access or elevated privileges authorization requirement.
Default authorization handler.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
The default authorization requirement.
Initializes a new instance of the class.
A value of .
Gets the required SyncPlay access.
User permission authorization handler.
Initializes a new instance of the class.
Instance of the interface.
The user permission requirement.
Initializes a new instance of the class.
The required .
Whether to validate the user's parental schedule.
Gets the required user permission.
Base api controller for the API setting a default route.
Create a new .
The value to return.
The type to return.
The .
Create a new .
The value to return.
The type to return.
The .
Authentication schemes for user authentication in the API.
Scheme name for the custom legacy authentication.
Internal claim types for authorization.
User Id.
Device Id.
Device.
Client.
Version.
Token.
Is Api Key.
Constants for user roles used in the authentication and authorization for the API.
Guest user.
Regular user with no special privileges.
Administrator user with elevated privileges.
Activity log controller.
Initializes a new instance of the class.
Instance of interface.
Gets activity log entries.
The record index to start at. All items with a lower index will be dropped from the results.
The maximum number of records to return.
The minimum date.
The maximum date.
Filter log entries if it has user id, or not.
Filter by name.
Filter by overview.
Filter by short overview.
Filter by type.
Filter by item id.
Filter by username.
Filter by log severity.
Specify one or more sort orders. Format: SortBy=Name,Type.
Sort Order..
Activity log returned.
A containing the log entries.
Authentication controller.
Initializes a new instance of the class.
Instance of interface.
Get all keys.
Api keys retrieved.
A with all keys.
Create a new api key.
Name of the app using the authentication key.
Api key created.
A .
Remove an api key.
The access token to delete.
Api key deleted.
A .
The artists controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets all artists from a given item, folder, or the entire library.
Optional filter by minimum community rating.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Search term.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output.
Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Optional. Specify additional filters to apply.
Optional filter by items that are marked as favorite, or not.
Optional filter by MediaType. Allows multiple, comma delimited.
Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
Optional, include user data.
Optional, the max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. If specified, results will be filtered to include only those containing the specified person.
Optional. If specified, results will be filtered to include only those containing the specified person ids.
Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
User id.
Optional filter by items whose name is sorted equally or greater than a given input string.
Optional filter by items whose name is sorted equally than a given input string.
Optional filter by items whose name is equally or lesser than a given input string.
Optional. Specify one or more sort orders, comma delimited.
Sort Order - Ascending,Descending.
Optional, include image information in output.
Total record count.
Artists returned.
An containing the artists.
Gets all album artists from a given item, folder, or the entire library.
Optional filter by minimum community rating.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Search term.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output.
Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Optional. Specify additional filters to apply.
Optional filter by items that are marked as favorite, or not.
Optional filter by MediaType. Allows multiple, comma delimited.
Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
Optional, include user data.
Optional, the max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. If specified, results will be filtered to include only those containing the specified person.
Optional. If specified, results will be filtered to include only those containing the specified person ids.
Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
User id.
Optional filter by items whose name is sorted equally or greater than a given input string.
Optional filter by items whose name is sorted equally than a given input string.
Optional filter by items whose name is equally or lesser than a given input string.
Optional. Specify one or more sort orders, comma delimited.
Sort Order - Ascending,Descending.
Optional, include image information in output.
Total record count.
Album artists returned.
An containing the album artists.
Gets an artist by name.
Studio name.
Optional. Filter by user id, and attach user data.
Artist returned.
An containing the artist.
The audio controller.
Initializes a new instance of the class.
Instance of .
Gets an audio stream.
The item id.
The audio container.
Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
The streaming parameters.
The tag.
Optional. The dlna device profile id to utilize.
The play session id.
The segment container.
The segment length.
The minimum number of segments.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.
Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
Whether or not to allow copying of the video stream url.
Whether or not to allow copying of the audio stream url.
Optional. Specify a specific audio sample rate, e.g. 44100.
Optional. The maximum audio bit depth.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a specific number of audio channels to encode to, e.g. 2.
Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The fixed horizontal resolution of the encoded video.
Optional. The fixed vertical resolution of the encoded video.
Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
Optional. Specify the subtitle delivery method.
Optional.
Optional. The maximum video bit depth.
Optional. Whether to require avc.
Optional. Whether to deinterlace the video.
Optional. Whether to require a non anamorphic stream.
Optional. The maximum number of audio channels to transcode.
Optional. The limit of how many cpu cores to use.
The live stream id.
Optional. Whether to enable the MpegtsM2Ts mode.
Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.
Optional. Specify a subtitle codec to encode to.
Optional. The transcoding reason.
Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
Optional. The index of the video stream to use. If omitted the first video stream will be used.
Optional. The .
Optional. The streaming options.
Optional. Whether to enable Audio Encoding.
Audio stream returned.
A containing the audio file.
Gets an audio stream.
The item id.
The audio container.
Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
The streaming parameters.
The tag.
Optional. The dlna device profile id to utilize.
The play session id.
The segment container.
The segment length.
The minimum number of segments.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.
Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
Whether or not to allow copying of the video stream url.
Whether or not to allow copying of the audio stream url.
Optional. Specify a specific audio sample rate, e.g. 44100.
Optional. The maximum audio bit depth.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a specific number of audio channels to encode to, e.g. 2.
Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The fixed horizontal resolution of the encoded video.
Optional. The fixed vertical resolution of the encoded video.
Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
Optional. Specify the subtitle delivery method.
Optional.
Optional. The maximum video bit depth.
Optional. Whether to require avc.
Optional. Whether to deinterlace the video.
Optional. Whether to require a non anamorphic stream.
Optional. The maximum number of audio channels to transcode.
Optional. The limit of how many cpu cores to use.
The live stream id.
Optional. Whether to enable the MpegtsM2Ts mode.
Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.
Optional. Specify a subtitle codec to encode to.
Optional. The transcoding reason.
Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
Optional. The index of the video stream to use. If omitted the first video stream will be used.
Optional. The .
Optional. The streaming options.
Optional. Whether to enable Audio Encoding.
Audio stream returned.
A containing the audio file.
The backup controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Creates a new Backup.
The backup options.
Backup created.
User does not have permission to retrieve information.
The created backup manifest.
Restores to a backup by restarting the server and applying the backup.
The data to start a restore process.
Backup restore started.
User does not have permission to retrieve information.
No-Content.
Gets a list of all currently present backups in the backup directory.
Backups available.
User does not have permission to retrieve information.
The list of backups.
Gets the descriptor from an existing archive is present.
The data to start a restore process.
Backup archive manifest.
Not a valid jellyfin Archive.
Not a valid path.
User does not have permission to retrieve information.
The backup manifest.
Branding controller.
Initializes a new instance of the class.
Instance of the interface.
Gets branding configuration.
Branding configuration returned.
An containing the branding configuration.
Gets branding css.
Branding css returned.
No branding css configured.
An containing the branding css if exist,
or a if the css is not configured.
Channels Controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Gets available channels.
User Id to filter by. Use to not filter by user.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Filter by channels that support getting latest items.
Optional. Filter by channels that support media deletion.
Optional. Filter by channels that are favorite.
Channels returned.
An containing the channels.
Get all channel features.
All channel features returned.
An containing the channel features.
Get channel features.
Channel id.
Channel features returned.
An containing the channel features.
Get channel items.
Channel Id.
Optional. Folder Id.
Optional. User Id.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Sort Order - Ascending,Descending.
Optional. Specify additional filters to apply.
Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
Optional. Specify additional fields of information to return in the output.
Channel items returned.
A representing the request to get the channel items.
The task result contains an containing the channel items.
Gets latest channel items.
Optional. User Id.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Specify additional filters to apply.
Optional. Specify additional fields of information to return in the output.
Optional. Specify one or more channel id's, comma delimited.
Latest channel items returned.
A representing the request to get the latest channel items.
The task result contains an containing the latest channel items.
Client log controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Upload a document.
Document saved.
Event logging disabled.
Upload size too large.
Create response.
The collection controller.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Creates a new collection.
The name of the collection.
Item Ids to add to the collection.
Optional. Create the collection within a specific folder.
Whether or not to lock the new collection.
Collection created.
A with information about the new collection.
Adds items to a collection.
The collection id.
Item ids, comma delimited.
Items added to collection.
A indicating success.
Removes items from a collection.
The collection id.
Item ids, comma delimited.
Items removed from collection.
A indicating success.
Configuration Controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Gets application configuration.
Application configuration returned.
Application configuration.
Updates application configuration.
Configuration.
Configuration updated.
Update status.
Gets a named configuration.
Configuration key.
Configuration returned.
Configuration.
Updates named configuration.
Configuration key.
Configuration.
Named configuration updated.
Update status.
Gets a default MetadataOptions object.
Metadata options returned.
Default MetadataOptions.
Updates branding configuration.
Branding configuration.
Branding configuration updated.
Update status.
The dashboard controller.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Gets the configuration pages.
Whether to enable in the main menu.
ConfigurationPages returned.
Server still loading.
An with infos about the plugins.
Gets a dashboard configuration page.
The name of the page.
ConfigurationPage returned.
Plugin configuration page not found.
The configuration page.
Exposes the PostgreSQL reporting views as read-only API endpoints.
All endpoints require administrator privileges.
Initializes a new instance of the class.
The EF Core context factory.
Gets a flat list of all media streams (audio + video columns merged).
Maps to library."MediaStreamInfos_v".
Optional item ID filter.
Optional stream type filter (0=Audio, 1=Video, 2=Subtitle).
Record index to start at.
Maximum records to return (1-1000, default 100).
List of media stream rows.
Gets video items joined with primary stream technical details.
Maps to library."VideoItems_v".
Optional partial type filter (e.g. "Movie", "Episode").
Optional minimum video height (e.g. 2160 for 4K).
Optional HDR format ("Dolby Vision", "HDR10+", "HDR10", "HLG", "SDR").
Record index to start at.
Maximum records to return (1-1000, default 100).
List of video item rows.
Gets per-user playback history with calculated progress percentages.
Maps to library."UserPlaybackHistory_v".
Optional exact username filter.
Optional item ID filter.
When true, returns only items started but not fully played.
Record index to start at.
Maximum records to return (1-1000, default 100).
List of playback history rows.
Gets items with their external provider IDs (IMDb, TMDB, TVDB, etc.) in named columns.
Maps to library."ItemProviders_v".
Optional partial type filter.
Optional exact IMDb ID filter.
Optional exact TMDB ID filter.
Optional exact TVDB ID filter.
Record index to start at.
Maximum records to return (1-1000, default 100).
List of item provider rows.
Gets cast and crew entries linked to the items they appear in.
Maps to library."ItemPeople_v".
Optional exact person name filter.
Optional person type filter (e.g. "Actor", "Director").
Optional item ID filter.
Record index to start at.
Maximum records to return (1-1000, default 100).
List of item person rows.
Gets aggregate library statistics - one row per item type.
Maps to library."LibrarySummary_v".
List of library summary rows, one per item type.
Devices Controller.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Get Devices.
Gets or sets the user identifier.
Devices retrieved.
An containing the list of devices.
Get info for a device.
Device Id.
Device info retrieved.
Device not found.
An containing the device info on success, or a if the device could not be found.
Get options for a device.
Device Id.
Device options retrieved.
Device not found.
An containing the device info on success, or a if the device could not be found.
Update device options.
Device Id.
Device Options.
Device options updated.
A .
Deletes a device.
Device Id.
Device deleted.
Device not found.
A on success, or a if the device could not be found.
Display Preferences Controller.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Get Display Preferences.
Display preferences id.
User id.
Client.
Display preferences retrieved.
An containing the display preferences on success, or a if the display preferences could not be found.
Update Display Preferences.
Display preferences id.
User Id.
Client.
New Display Preferences object.
Display preferences updated.
An on success.
Dynamic hls controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of .
Instance of .
Instance of .
Gets a hls live stream.
The item id.
The audio container.
Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
The streaming parameters.
The tag.
Optional. The dlna device profile id to utilize.
The play session id.
The segment container.
The segment length.
The minimum number of segments.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. Specify an audio codec to encode to, e.g. mp3.
Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
Whether or not to allow copying of the video stream url.
Whether or not to allow copying of the audio stream url.
Optional. Specify a specific audio sample rate, e.g. 44100.
Optional. The maximum audio bit depth.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a specific number of audio channels to encode to, e.g. 2.
Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The fixed horizontal resolution of the encoded video.
Optional. The fixed vertical resolution of the encoded video.
Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
Optional. Specify the subtitle delivery method.
Optional.
Optional. The maximum video bit depth.
Optional. Whether to require avc.
Optional. Whether to deinterlace the video.
Optional. Whether to require a non anamorphic stream.
Optional. The maximum number of audio channels to transcode.
Optional. The limit of how many cpu cores to use.
The live stream id.
Optional. Whether to enable the MpegtsM2Ts mode.
Optional. Specify a video codec to encode to, e.g. h264.
Optional. Specify a subtitle codec to encode to.
Optional. The transcoding reason.
Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
Optional. The index of the video stream to use. If omitted the first video stream will be used.
Optional. The .
Optional. The streaming options.
Optional. The max width.
Optional. The max height.
Optional. Whether to enable subtitles in the manifest.
Optional. Whether to enable Audio Encoding.
Whether to always burn in subtitles when transcoding.
Hls live stream retrieved.
A containing the hls file.
Gets a video hls playlist stream.
The item id.
Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
The streaming parameters.
The tag.
Optional. The dlna device profile id to utilize.
The play session id.
The segment container.
The segment length.
The minimum number of segments.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. Specify an audio codec to encode to, e.g. mp3.
Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
Whether or not to allow copying of the video stream url.
Whether or not to allow copying of the audio stream url.
Optional. Specify a specific audio sample rate, e.g. 44100.
Optional. The maximum audio bit depth.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a specific number of audio channels to encode to, e.g. 2.
Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The fixed horizontal resolution of the encoded video.
Optional. The fixed vertical resolution of the encoded video.
Optional. The maximum horizontal resolution of the encoded video.
Optional. The maximum vertical resolution of the encoded video.
Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
Optional. Specify the subtitle delivery method.
Optional.
Optional. The maximum video bit depth.
Optional. Whether to require avc.
Optional. Whether to deinterlace the video.
Optional. Whether to require a non anamorphic stream.
Optional. The maximum number of audio channels to transcode.
Optional. The limit of how many cpu cores to use.
The live stream id.
Optional. Whether to enable the MpegtsM2Ts mode.
Optional. Specify a video codec to encode to, e.g. h264.
Optional. Specify a subtitle codec to encode to.
Optional. The transcoding reason.
Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
Optional. The index of the video stream to use. If omitted the first video stream will be used.
Optional. The .
Optional. The streaming options.
Enable adaptive bitrate streaming.
Enable trickplay image playlists being added to master playlist.
Whether to enable Audio Encoding.
Whether to always burn in subtitles when transcoding.
Video stream returned.
A containing the playlist file.
Gets an audio hls playlist stream.
The item id.
Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
The streaming parameters.
The tag.
Optional. The dlna device profile id to utilize.
The play session id.
The segment container.
The segment length.
The minimum number of segments.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. Specify an audio codec to encode to, e.g. mp3.
Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
Whether or not to allow copying of the video stream url.
Whether or not to allow copying of the audio stream url.
Optional. Specify a specific audio sample rate, e.g. 44100.
Optional. The maximum audio bit depth.
Optional. The maximum streaming bitrate.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a specific number of audio channels to encode to, e.g. 2.
Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The fixed horizontal resolution of the encoded video.
Optional. The fixed vertical resolution of the encoded video.
Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
Optional. Specify the subtitle delivery method.
Optional.
Optional. The maximum video bit depth.
Optional. Whether to require avc.
Optional. Whether to deinterlace the video.
Optional. Whether to require a non anamorphic stream.
Optional. The maximum number of audio channels to transcode.
Optional. The limit of how many cpu cores to use.
The live stream id.
Optional. Whether to enable the MpegtsM2Ts mode.
Optional. Specify a video codec to encode to, e.g. h264.
Optional. Specify a subtitle codec to encode to.
Optional. The transcoding reason.
Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
Optional. The index of the video stream to use. If omitted the first video stream will be used.
Optional. The .
Optional. The streaming options.
Enable adaptive bitrate streaming.
Optional. Whether to enable Audio Encoding.
Audio stream returned.
A containing the playlist file.
Gets a video stream using HTTP live streaming.
The item id.
Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
The streaming parameters.
The tag.
Optional. The dlna device profile id to utilize.
The play session id.
The segment container.
The segment length.
The minimum number of segments.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. Specify an audio codec to encode to, e.g. mp3.
Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
Whether or not to allow copying of the video stream url.
Whether or not to allow copying of the audio stream url.
Optional. Specify a specific audio sample rate, e.g. 44100.
Optional. The maximum audio bit depth.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a specific number of audio channels to encode to, e.g. 2.
Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The fixed horizontal resolution of the encoded video.
Optional. The fixed vertical resolution of the encoded video.
Optional. The maximum horizontal resolution of the encoded video.
Optional. The maximum vertical resolution of the encoded video.
Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
Optional. Specify the subtitle delivery method.
Optional.
Optional. The maximum video bit depth.
Optional. Whether to require avc.
Optional. Whether to deinterlace the video.
Optional. Whether to require a non anamorphic stream.
Optional. The maximum number of audio channels to transcode.
Optional. The limit of how many cpu cores to use.
The live stream id.
Optional. Whether to enable the MpegtsM2Ts mode.
Optional. Specify a video codec to encode to, e.g. h264.
Optional. Specify a subtitle codec to encode to.
Optional. The transcoding reason.
Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
Optional. The index of the video stream to use. If omitted the first video stream will be used.
Optional. The .
Optional. The streaming options.
Optional. Whether to enable Audio Encoding.
Whether to always burn in subtitles when transcoding.
Video stream returned.
A containing the audio file.
Gets an audio stream using HTTP live streaming.
The item id.
Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
The streaming parameters.
The tag.
Optional. The dlna device profile id to utilize.
The play session id.
The segment container.
The segment length.
The minimum number of segments.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. Specify an audio codec to encode to, e.g. mp3.
Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
Whether or not to allow copying of the video stream url.
Whether or not to allow copying of the audio stream url.
Optional. Specify a specific audio sample rate, e.g. 44100.
Optional. The maximum audio bit depth.
Optional. The maximum streaming bitrate.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a specific number of audio channels to encode to, e.g. 2.
Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The fixed horizontal resolution of the encoded video.
Optional. The fixed vertical resolution of the encoded video.
Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
Optional. Specify the subtitle delivery method.
Optional.
Optional. The maximum video bit depth.
Optional. Whether to require avc.
Optional. Whether to deinterlace the video.
Optional. Whether to require a non anamorphic stream.
Optional. The maximum number of audio channels to transcode.
Optional. The limit of how many cpu cores to use.
The live stream id.
Optional. Whether to enable the MpegtsM2Ts mode.
Optional. Specify a video codec to encode to, e.g. h264.
Optional. Specify a subtitle codec to encode to.
Optional. The transcoding reason.
Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
Optional. The index of the video stream to use. If omitted the first video stream will be used.
Optional. The .
Optional. The streaming options.
Optional. Whether to enable Audio Encoding.
Audio stream returned.
A containing the audio file.
Gets a video stream using HTTP live streaming.
The item id.
The playlist id.
The segment id.
The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
The position of the requested segment in ticks.
The length of the requested segment in ticks.
Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
The streaming parameters.
The tag.
Optional. The dlna device profile id to utilize.
The play session id.
The segment container.
The desired segment length.
The minimum number of segments.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. Specify an audio codec to encode to, e.g. mp3.
Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
Whether or not to allow copying of the video stream url.
Whether or not to allow copying of the audio stream url.
Optional. Specify a specific audio sample rate, e.g. 44100.
Optional. The maximum audio bit depth.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a specific number of audio channels to encode to, e.g. 2.
Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The fixed horizontal resolution of the encoded video.
Optional. The fixed vertical resolution of the encoded video.
Optional. The maximum horizontal resolution of the encoded video.
Optional. The maximum vertical resolution of the encoded video.
Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
Optional. Specify the subtitle delivery method.
Optional.
Optional. The maximum video bit depth.
Optional. Whether to require avc.
Optional. Whether to deinterlace the video.
Optional. Whether to require a non anamorphic stream.
Optional. The maximum number of audio channels to transcode.
Optional. The limit of how many cpu cores to use.
The live stream id.
Optional. Whether to enable the MpegtsM2Ts mode.
Optional. Specify a video codec to encode to, e.g. h264.
Optional. Specify a subtitle codec to encode to.
Optional. The transcoding reason.
Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
Optional. The index of the video stream to use. If omitted the first video stream will be used.
Optional. The .
Optional. The streaming options.
Optional. Whether to enable Audio Encoding.
Whether to always burn in subtitles when transcoding.
Video stream returned.
A containing the audio file.
Gets a video stream using HTTP live streaming.
The item id.
The playlist id.
The segment id.
The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
The position of the requested segment in ticks.
The length of the requested segment in ticks.
Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
The streaming parameters.
The tag.
Optional. The dlna device profile id to utilize.
The play session id.
The segment container.
The segment length.
The minimum number of segments.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. Specify an audio codec to encode to, e.g. mp3.
Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
Whether or not to allow copying of the video stream url.
Whether or not to allow copying of the audio stream url.
Optional. Specify a specific audio sample rate, e.g. 44100.
Optional. The maximum audio bit depth.
Optional. The maximum streaming bitrate.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a specific number of audio channels to encode to, e.g. 2.
Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The fixed horizontal resolution of the encoded video.
Optional. The fixed vertical resolution of the encoded video.
Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
Optional. Specify the subtitle delivery method.
Optional.
Optional. The maximum video bit depth.
Optional. Whether to require avc.
Optional. Whether to deinterlace the video.
Optional. Whether to require a non anamorphic stream.
Optional. The maximum number of audio channels to transcode.
Optional. The limit of how many cpu cores to use.
The live stream id.
Optional. Whether to enable the MpegtsM2Ts mode.
Optional. Specify a video codec to encode to, e.g. h264.
Optional. Specify a subtitle codec to encode to.
Optional. The transcoding reason.
Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
Optional. The index of the video stream to use. If omitted the first video stream will be used.
Optional. The .
Optional. The streaming options.
Optional. Whether to enable Audio Encoding.
Video stream returned.
A containing the audio file.
Gets the audio arguments for transcoding.
The .
The command line arguments for audio transcoding.
Gets the video arguments for transcoding.
The .
The first number in the hls sequence.
Whether the playlist is EVENT or VOD.
The segment container.
The command line arguments for video transcoding.
Environment Controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Gets the contents of a given directory in the file system.
The path.
An optional filter to include or exclude files from the results. true/false.
An optional filter to include or exclude folders from the results. true/false.
Directory contents returned.
Directory contents.
Validates path.
Validate request object.
Path validated.
Path not found.
Validation status.
Gets available drives from the server's file system.
List of entries returned.
List of entries.
Gets the parent path of a given path.
The path.
Parent path.
Get Default directory browser.
Default directory browser returned.
Default directory browser.
Filters controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Gets legacy query filters.
Optional. User id.
Optional. Parent id.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Optional. Filter by MediaType. Allows multiple, comma delimited.
Legacy filters retrieved.
Legacy query filters.
Gets query filters.
Optional. User id.
Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Optional. Is item airing.
Optional. Is item movie.
Optional. Is item sports.
Optional. Is item kids.
Optional. Is item news.
Optional. Is item series.
Optional. Search recursive.
Filters retrieved.
Query filters.
The genres controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets all genres from a given item, folder, or the entire library.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
The search term.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output.
Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited.
Optional filter by items that are marked as favorite, or not.
Optional, the max number of images to return, per image type.
Optional. The image types to include in the output.
User id.
Optional filter by items whose name is sorted equally or greater than a given input string.
Optional filter by items whose name is sorted equally than a given input string.
Optional filter by items whose name is equally or lesser than a given input string.
Optional. Specify one or more sort orders, comma delimited.
Sort Order - Ascending,Descending.
Optional, include image information in output.
Optional. Include total record count.
Genres returned.
An containing the queryresult of genres.
Gets a genre, by name.
The genre name.
The user id.
Genres returned.
An containing the genre.
The hls segment controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets the specified audio segment for an audio item.
The item id.
The segment id.
Hls audio segment returned.
A containing the audio stream.
Gets a hls video playlist.
The video id.
The playlist id.
Hls video playlist returned.
A containing the playlist.
Stops an active encoding.
The device id of the client requesting. Used to stop encoding processes when needed.
The play session id.
Encoding stopped successfully.
A indicating success.
Gets a hls video segment.
The item id.
The playlist id.
The segment id.
The segment container.
Hls video segment returned.
Hls segment not found.
A containing the video segment.
Image controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Sets the user image.
User Id.
Image updated.
User does not have permission to delete the image.
Item not found.
A .
Sets the user image.
User Id.
(Unused) Image type.
Image updated.
User does not have permission to delete the image.
A .
Sets the user image.
User Id.
(Unused) Image type.
(Unused) Image index.
Image updated.
User does not have permission to delete the image.
A .
Delete the user's image.
User Id.
Image deleted.
User does not have permission to delete the image.
A .
Delete the user's image.
User Id.
(Unused) Image type.
(Unused) Image index.
Image deleted.
User does not have permission to delete the image.
A .
Delete the user's image.
User Id.
(Unused) Image type.
(Unused) Image index.
Image deleted.
User does not have permission to delete the image.
A .
Delete an item's image.
Item id.
Image type.
The image index.
Image deleted.
Item not found.
A on success, or a if item not found.
Delete an item's image.
Item id.
Image type.
The image index.
Image deleted.
Item not found.
A on success, or a if item not found.
Set item image.
Item id.
Image type.
Image saved.
Item not found.
A on success, or a if item not found.
Set item image.
Item id.
Image type.
(Unused) Image index.
Image saved.
Item not found.
A on success, or a if item not found.
Updates the index for an item image.
Item id.
Image type.
Old image index.
New image index.
Image index updated.
Item not found.
A on success, or a if item not found.
Get item image infos.
Item id.
Item images returned.
Item not found.
The list of image infos on success, or if item not found.
Gets the item's image.
Item id.
Image type.
The maximum image width to return.
The maximum image height to return.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Optional. The of the returned image.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image index.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Gets the item's image.
Item id.
Image type.
Image index.
The maximum image width to return.
The maximum image height to return.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Optional. The of the returned image.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Gets the item's image.
Item id.
Image type.
The maximum image width to return.
The maximum image height to return.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image index.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Get artist image by name.
Artist name.
Image type.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
The maximum image width to return.
The maximum image height to return.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image index.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Get genre image by name.
Genre name.
Image type.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
The maximum image width to return.
The maximum image height to return.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image index.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Get genre image by name.
Genre name.
Image type.
Image index.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
The maximum image width to return.
The maximum image height to return.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Get music genre image by name.
Music genre name.
Image type.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
The maximum image width to return.
The maximum image height to return.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image index.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Get music genre image by name.
Music genre name.
Image type.
Image index.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
The maximum image width to return.
The maximum image height to return.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Get person image by name.
Person name.
Image type.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
The maximum image width to return.
The maximum image height to return.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image index.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Get person image by name.
Person name.
Image type.
Image index.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
The maximum image width to return.
The maximum image height to return.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Get studio image by name.
Studio name.
Image type.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
The maximum image width to return.
The maximum image height to return.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image index.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Get studio image by name.
Studio name.
Image type.
Image index.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
The maximum image width to return.
The maximum image height to return.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Get user profile image.
User id.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
Image stream returned.
User id not provided.
Item not found.
A containing the file stream on success,
or a if item not found.
Get user profile image.
User id.
Image type.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
The maximum image width to return.
The maximum image height to return.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image index.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Get user profile image.
User id.
Image type.
Image index.
Optional. Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
The maximum image width to return.
The maximum image height to return.
Optional. Percent to render for the percent played overlay.
Optional. Unplayed count overlay to render.
The fixed image width to return.
The fixed image height to return.
Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Width of box to fill.
Height of box to fill.
Optional. Blur image.
Optional. Apply a background color for transparent images.
Optional. Apply a foreground layer on top of the image.
Image stream returned.
Item not found.
A containing the file stream on success,
or a if item not found.
Generates or gets the splashscreen.
Supply the cache tag from the item object to receive strong caching headers.
Determines the output format of the image - original,gif,jpg,png.
Splashscreen returned successfully.
The splashscreen.
Uploads a custom splashscreen.
The body is expected to the image contents base64 encoded.
A indicating success.
Successfully uploaded new splashscreen.
Error reading MimeType from uploaded image.
User does not have permission to upload splashscreen..
Error reading the image format.
Delete a custom splashscreen.
A indicating success.
Successfully deleted the custom splashscreen.
User does not have permission to delete splashscreen..
The instant mix controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Creates an instant playlist based on a given song.
The item id.
Optional. Filter by user id, and attach user data.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output.
Optional. Include image information in output.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Instant playlist returned.
Item not found.
A with the playlist items.
Creates an instant playlist based on a given album.
The item id.
Optional. Filter by user id, and attach user data.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output.
Optional. Include image information in output.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Instant playlist returned.
Item not found.
A with the playlist items.
Creates an instant playlist based on a given playlist.
The item id.
Optional. Filter by user id, and attach user data.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output.
Optional. Include image information in output.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Instant playlist returned.
Item not found.
A with the playlist items.
Creates an instant playlist based on a given genre.
The genre name.
Optional. Filter by user id, and attach user data.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output.
Optional. Include image information in output.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Instant playlist returned.
A with the playlist items.
Creates an instant playlist based on a given artist.
The item id.
Optional. Filter by user id, and attach user data.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output.
Optional. Include image information in output.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Instant playlist returned.
Item not found.
A with the playlist items.
Creates an instant playlist based on a given item.
The item id.
Optional. Filter by user id, and attach user data.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output.
Optional. Include image information in output.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Instant playlist returned.
Item not found.
A with the playlist items.
Creates an instant playlist based on a given artist.
The item id.
Optional. Filter by user id, and attach user data.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output.
Optional. Include image information in output.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Instant playlist returned.
Item not found.
A with the playlist items.
Creates an instant playlist based on a given genre.
The item id.
Optional. Filter by user id, and attach user data.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output.
Optional. Include image information in output.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Instant playlist returned.
Item not found.
A with the playlist items.
Item lookup controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Get the item's external id info.
Item id.
External id info retrieved.
Item not found.
List of external id info.
Get movie remote search.
Remote search query.
Movie remote search executed.
A that represents the asynchronous operation to get the remote search results.
The task result contains an containing the list of remote search results.
Get trailer remote search.
Remote search query.
Trailer remote search executed.
A that represents the asynchronous operation to get the remote search results.
The task result contains an containing the list of remote search results.
Get music video remote search.
Remote search query.
Music video remote search executed.
A that represents the asynchronous operation to get the remote search results.
The task result contains an containing the list of remote search results.
Get series remote search.
Remote search query.
Series remote search executed.
A that represents the asynchronous operation to get the remote search results.
The task result contains an containing the list of remote search results.
Get box set remote search.
Remote search query.
Box set remote search executed.
A that represents the asynchronous operation to get the remote search results.
The task result contains an containing the list of remote search results.
Get music artist remote search.
Remote search query.
Music artist remote search executed.
A that represents the asynchronous operation to get the remote search results.
The task result contains an containing the list of remote search results.
Get music album remote search.
Remote search query.
Music album remote search executed.
A that represents the asynchronous operation to get the remote search results.
The task result contains an containing the list of remote search results.
Get person remote search.
Remote search query.
Person remote search executed.
A that represents the asynchronous operation to get the remote search results.
The task result contains an containing the list of remote search results.
Get book remote search.
Remote search query.
Book remote search executed.
A that represents the asynchronous operation to get the remote search results.
The task result contains an containing the list of remote search results.
Applies search criteria to an item and refreshes metadata.
Item id.
The remote search result.
Optional. Whether or not to replace all images. Default: True.
Item metadata refreshed.
Item not found.
A that represents the asynchronous operation to get the remote search results.
The task result contains an .
Item Refresh Controller.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Instance of interface.
Refreshes metadata for an item.
Item id.
(Optional) Specifies the metadata refresh mode.
(Optional) Specifies the image refresh mode.
(Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.
(Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.
(Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh.
Item metadata refresh queued.
Item to refresh not found.
An on success, or a if the item could not be found.
The items controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets items based on a query.
The user id supplied as query parameter; this is required when not using an API key.
Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
Optional filter by items with theme songs.
Optional filter by items with theme videos.
Optional filter by items with subtitles.
Optional filter by items with special features.
Optional filter by items with trailers.
Optional. Return items that are siblings of a supplied item.
Optional filter by index number.
Optional filter by parent index number.
Optional filter by items that have or do not have a parental rating.
Optional filter by items that are HD or not.
Optional filter by items that are 4K or not.
Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
Optional filter by items that are missing episodes or not.
Optional filter by items that are unaired episodes or not.
Optional filter by minimum community rating.
Optional filter by minimum critic rating.
Optional. The minimum premiere date. Format = ISO.
Optional. The minimum last saved date. Format = ISO.
Optional. The minimum last saved date for the current user. Format = ISO.
Optional. The maximum premiere date. Format = ISO.
Optional filter by items that have an overview or not.
Optional filter by items that have an IMDb id or not.
Optional filter by items that have a TMDb id or not.
Optional filter by items that have a TVDb id or not.
Optional filter for live tv movies.
Optional filter for live tv series.
Optional filter for live tv news.
Optional filter for live tv kids.
Optional filter for live tv sports.
Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
When searching within folders, this determines whether or not the search will be recursive. true/false.
Optional. Filter based on a search term.
Sort Order - Ascending, Descending.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
Optional filter by items that are marked as favorite, or not.
Optional filter by MediaType. Allows multiple, comma delimited.
Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
Optional filter by items that are played, or not.
Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
Optional, include user data.
Optional, the max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. If specified, results will be filtered to include only those containing the specified person.
Optional. If specified, results will be filtered to include only those containing the specified person id.
Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered to include only those containing the specified artist id.
Optional. If specified, results will be filtered to include only those containing the specified album artist id.
Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.
Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
Optional filter by items that are locked.
Optional filter by items that are placeholders.
Optional filter by items that have official ratings.
Whether or not to hide items behind their boxsets.
Optional. Filter by the minimum width of the item.
Optional. Filter by the minimum height of the item.
Optional. Filter by the maximum width of the item.
Optional. Filter by the maximum height of the item.
Optional filter by items that are 3D, or not.
Optional filter by Series Status. Allows multiple, comma delimited.
Optional filter by items whose name is sorted equally or greater than a given input string.
Optional filter by items whose name is sorted equally than a given input string.
Optional filter by items whose name is equally or lesser than a given input string.
Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
Optional. Enable the total record count.
Optional, include image information in output.
A with the items.
Gets items based on a query.
The user id supplied as query parameter.
Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
Optional filter by items with theme songs.
Optional filter by items with theme videos.
Optional filter by items with subtitles.
Optional filter by items with special features.
Optional filter by items with trailers.
Optional. Return items that are siblings of a supplied item.
Optional filter by parent index number.
Optional filter by items that have or do not have a parental rating.
Optional filter by items that are HD or not.
Optional filter by items that are 4K or not.
Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
Optional filter by items that are missing episodes or not.
Optional filter by items that are unaired episodes or not.
Optional filter by minimum community rating.
Optional filter by minimum critic rating.
Optional. The minimum premiere date. Format = ISO.
Optional. The minimum last saved date. Format = ISO.
Optional. The minimum last saved date for the current user. Format = ISO.
Optional. The maximum premiere date. Format = ISO.
Optional filter by items that have an overview or not.
Optional filter by items that have an IMDb id or not.
Optional filter by items that have a TMDb id or not.
Optional filter by items that have a TVDb id or not.
Optional filter for live tv movies.
Optional filter for live tv series.
Optional filter for live tv news.
Optional filter for live tv kids.
Optional filter for live tv sports.
Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
When searching within folders, this determines whether or not the search will be recursive. true/false.
Optional. Filter based on a search term.
Sort Order - Ascending, Descending.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
Optional filter by items that are marked as favorite, or not.
Optional filter by MediaType. Allows multiple, comma delimited.
Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
Optional filter by items that are played, or not.
Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
Optional, include user data.
Optional, the max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. If specified, results will be filtered to include only those containing the specified person.
Optional. If specified, results will be filtered to include only those containing the specified person id.
Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered to include only those containing the specified artist id.
Optional. If specified, results will be filtered to include only those containing the specified album artist id.
Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.
Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
Optional filter by items that are locked.
Optional filter by items that are placeholders.
Optional filter by items that have official ratings.
Whether or not to hide items behind their boxsets.
Optional. Filter by the minimum width of the item.
Optional. Filter by the minimum height of the item.
Optional. Filter by the maximum width of the item.
Optional. Filter by the maximum height of the item.
Optional filter by items that are 3D, or not.
Optional filter by Series Status. Allows multiple, comma delimited.
Optional filter by items whose name is sorted equally or greater than a given input string.
Optional filter by items whose name is sorted equally than a given input string.
Optional filter by items whose name is equally or lesser than a given input string.
Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
Optional. Enable the total record count.
Optional, include image information in output.
A with the items.
Gets items based on a query.
The user id.
The start index.
The item limit.
The search term.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
Optional. Filter by MediaType. Allows multiple, comma delimited.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
Optional. Enable the total record count.
Optional. Include image information in output.
Optional. Whether to exclude the currently active sessions.
Items returned.
A with the items that are resumable.
Gets items based on a query.
The user id.
The start index.
The item limit.
The search term.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
Optional. Filter by MediaType. Allows multiple, comma delimited.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
Optional. Enable the total record count.
Optional. Include image information in output.
Optional. Whether to exclude the currently active sessions.
Items returned.
A with the items that are resumable.
Get Item User Data.
The user id.
The item id.
return item user data.
Item is not found.
Return .
Get Item User Data.
The user id.
The item id.
return item user data.
Item is not found.
Return .
Update Item User Data.
The user id.
The item id.
New user data object.
return updated user item data.
Item is not found.
Return .
Update Item User Data.
The user id.
The item id.
New user data object.
return updated user item data.
Item is not found.
Return .
Item update controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Updates an item.
The item id.
The new item properties.
Item updated.
Item not found.
An on success, or a if the item could not be found.
Gets metadata editor info for an item.
The item id.
Item metadata editor returned.
Item not found.
An on success containing the metadata editor, or a if the item could not be found.
Updates an item's content type.
The item id.
The content type of the item.
Item content type updated.
Item not found.
An on success, or a if the item could not be found.
Library Controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Get the original file of an item.
The item id.
File stream returned.
Item not found.
A with the original file.
Gets critic review for an item.
Critic reviews returned.
The list of critic reviews.
Get theme songs for an item.
The item id.
Optional. Filter by user id, and attach user data.
Optional. Determines whether or not parent items should be searched for theme media.
Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
Optional. Sort Order - Ascending, Descending.
Theme songs returned.
Item not found.
The item theme songs.
Get theme videos for an item.
The item id.
Optional. Filter by user id, and attach user data.
Optional. Determines whether or not parent items should be searched for theme media.
Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
Optional. Sort Order - Ascending, Descending.
Theme videos returned.
Item not found.
The item theme videos.
Get theme songs and videos for an item.
The item id.
Optional. Filter by user id, and attach user data.
Optional. Determines whether or not parent items should be searched for theme media.
Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
Optional. Sort Order - Ascending, Descending.
Theme songs and videos returned.
Item not found.
The item theme videos.
Starts a library scan.
Library scan started.
A .
Deletes an item from the library and filesystem.
The item id.
Item deleted.
Unauthorized access.
Item not found.
A .
Deletes items from the library and filesystem.
The item ids.
Items deleted.
Unauthorized access.
A .
Get item counts.
Optional. Get counts from a specific user's library.
Optional. Get counts of favorite items.
Item counts returned.
Item counts.
Gets all parents of an item.
The item id.
Optional. Filter by user id, and attach user data.
Item parents returned.
Item not found.
Item parents.
Gets a list of physical paths from virtual folders.
Physical paths returned.
List of physical paths.
Gets all user media folders.
Optional. Filter by folders that are marked hidden, or not.
Media folders returned.
List of user media folders.
Reports that new episodes of a series have been added by an external source.
The tvdbId.
Report success.
A .
Reports that new movies have been added by an external source.
The tmdbId.
The imdbId.
Report success.
A .
Reports that new movies have been added by an external source.
The update paths.
Report success.
A .
Downloads item media.
The item id.
Media downloaded.
Item not found.
A containing the media stream.
User can't download or item can't be downloaded.
Gets similar items.
The item id.
Exclude artist ids.
Optional. Filter by user id, and attach user data.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
Similar items returned.
A containing the similar items.
Gets the library options info.
Library content type.
Whether this is a new library.
Library options info returned.
Library options info.
The library structure controller.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Instance of interface.
Gets all virtual folders.
Virtual folders retrieved.
An with the virtual folders.
Adds a virtual folder.
The name of the virtual folder.
The type of the collection.
The paths of the virtual folder.
The library options.
Whether to refresh the library.
Folder added.
A .
Removes a virtual folder.
The name of the folder.
Whether to refresh the library.
Folder removed.
Folder not found.
A .
Renames a virtual folder.
The name of the virtual folder.
The new name.
Whether to refresh the library.
Folder renamed.
Library doesn't exist.
Library already exists.
A on success, a if the library doesn't exist, a if the new name is already taken.
The new name may not be null.
Add a media path to a library.
The media path dto.
Whether to refresh the library.
A .
Media path added.
The name of the library may not be empty.
Updates a media path.
The name of the library and path infos.
A .
Media path updated.
The name of the library may not be empty.
Remove a media path.
The name of the library.
The path to remove.
Whether to refresh the library.
A .
Media path removed.
The name of the library and path may not be empty.
Update library options.
The library name and options.
Library updated.
Item not found.
A .
Live tv controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets available live tv services.
Available live tv services returned.
An containing the available live tv services.
Gets available live tv channels.
Optional. Filter by channel type.
Optional. Filter by user and attach user data.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. Filter for movies.
Optional. Filter for series.
Optional. Filter for news.
Optional. Filter for kids.
Optional. Filter for sports.
Optional. The maximum number of records to return.
Optional. Filter by channels that are favorites, or not.
Optional. Filter by channels that are liked, or not.
Optional. Filter by channels that are disliked, or not.
Optional. Include image information in output.
Optional. The max number of images to return, per image type.
"Optional. The image types to include in the output.
Optional. Specify additional fields of information to return in the output.
Optional. Include user data.
Optional. Key to sort by.
Optional. Sort order.
Optional. Incorporate favorite and like status into channel sorting.
Optional. Adds current program info to each channel.
Available live tv channels returned.
An containing the resulting available live tv channels.
Gets a live tv channel.
Channel id.
Optional. Attach user data.
Live tv channel returned.
Item not found.
An containing the live tv channel.
Gets live tv recordings.
Optional. Filter by channel id.
Optional. Filter by user and attach user data.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Filter by recording status.
Optional. Filter by recordings that are in progress, or not.
Optional. Filter by recordings belonging to a series timer.
Optional. Include image information in output.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. Specify additional fields of information to return in the output.
Optional. Include user data.
Optional. Filter for movies.
Optional. Filter for series.
Optional. Filter for kids.
Optional. Filter for sports.
Optional. Filter for news.
Optional. Filter for is library item.
Optional. Return total record count.
Live tv recordings returned.
An containing the live tv recordings.
Gets live tv recording series.
Optional. Filter by channel id.
Optional. Filter by user and attach user data.
Optional. Filter by recording group.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Filter by recording status.
Optional. Filter by recordings that are in progress, or not.
Optional. Filter by recordings belonging to a series timer.
Optional. Include image information in output.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. Specify additional fields of information to return in the output.
Optional. Include user data.
Optional. Return total record count.
Live tv recordings returned.
An containing the live tv recordings.
Gets live tv recording groups.
Optional. Filter by user and attach user data.
Recording groups returned.
An containing the recording groups.
Gets recording folders.
Optional. Filter by user and attach user data.
Recording folders returned.
An containing the recording folders.
Gets a live tv recording.
Recording id.
Optional. Attach user data.
Recording returned.
Item not found.
An containing the live tv recording.
Resets a tv tuner.
Tuner id.
Tuner reset.
A .
Gets a timer.
Timer id.
Timer returned.
A containing an which contains the timer.
Gets the default values for a new timer.
Optional. To attach default values based on a program.
Default values returned.
A containing an which contains the default values for a timer.
Gets the live tv timers.
Optional. Filter by channel id.
Optional. Filter by timers belonging to a series timer.
Optional. Filter by timers that are active.
Optional. Filter by timers that are scheduled.
A containing an which contains the live tv timers.
Gets available live tv epgs.
The channels to return guide information for.
Optional. Filter by user id.
Optional. The minimum premiere start date.
Optional. Filter by programs that have completed airing, or not.
Optional. Filter by programs that are currently airing, or not.
Optional. The maximum premiere start date.
Optional. The minimum premiere end date.
Optional. The maximum premiere end date.
Optional. Filter for movies.
Optional. Filter for series.
Optional. Filter for news.
Optional. Filter for kids.
Optional. Filter for sports.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.
Sort Order - Ascending,Descending.
The genres to return guide information for.
The genre ids to return guide information for.
Optional. Include image information in output.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. Include user data.
Optional. Filter by series timer id.
Optional. Filter by library series id.
Optional. Specify additional fields of information to return in the output.
Retrieve total record count.
Live tv epgs returned.
A containing a which contains the live tv epgs.
Gets available live tv epgs.
Request body.
Live tv epgs returned.
A containing a which contains the live tv epgs.
Gets recommended live tv epgs.
Optional. filter by user id.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Filter by programs that are currently airing, or not.
Optional. Filter by programs that have completed airing, or not.
Optional. Filter for series.
Optional. Filter for movies.
Optional. Filter for news.
Optional. Filter for kids.
Optional. Filter for sports.
Optional. Include image information in output.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
The genres to return guide information for.
Optional. Specify additional fields of information to return in the output.
Optional. include user data.
Retrieve total record count.
Recommended epgs returned.
A containing the queryresult of recommended epgs.
Gets a live tv program.
Program id.
Optional. Attach user data.
Program returned.
An containing the livetv program.
Deletes a live tv recording.
Recording id.
Recording deleted.
Item not found.
A on success, or a if item not found.
Cancels a live tv timer.
Timer id.
Timer deleted.
A .
Updates a live tv timer.
Timer id.
New timer info.
Timer updated.
A .
Creates a live tv timer.
New timer info.
Timer created.
A .
Gets a live tv series timer.
Timer id.
Series timer returned.
Series timer not found.
A on success, or a if timer not found.
Gets live tv series timers.
Optional. Sort by SortName or Priority.
Optional. Sort in Ascending or Descending order.
Timers returned.
An of live tv series timers.
Cancels a live tv series timer.
Timer id.
Timer cancelled.
A .
Updates a live tv series timer.
Timer id.
New series timer info.
Series timer updated.
A .
Creates a live tv series timer.
New series timer info.
Series timer info created.
A .
Get recording group.
Group id.
A .
Get guide info.
Guide info returned.
An containing the guide info.
Adds a tuner host.
New tuner host.
Created tuner host returned.
A containing the created tuner host.
Deletes a tuner host.
Tuner host id.
Tuner host deleted.
A .
Gets default listings provider info.
Default listings provider info returned.
An containing the default listings provider info.
Adds a listings provider.
Password.
New listings info.
Validate listings.
Validate login.
Created listings provider returned.
A containing the created listings provider.
Delete listing provider.
Listing provider id.
Listing provider deleted.
A .
Gets available lineups.
Provider id.
Provider type.
Location.
Country.
Available lineups returned.
A containing the available lineups.
Gets available countries.
Available countries returned.
A containing the available countries.
Get channel mapping options.
Provider id.
Channel mapping options returned.
An containing the channel mapping options.
Set channel mappings.
The set channel mapping dto.
Created channel mapping returned.
An containing the created channel mapping.
Get tuner host types.
Tuner host types returned.
An containing the tuner host types.
Discover tuners.
Only discover new tuners.
Tuners returned.
An containing the tuners.
Gets a live tv recording stream.
Recording id.
Recording stream returned.
Recording not found.
An containing the recording stream on success,
or a if recording not found.
Gets a live tv channel stream.
Stream id.
Container type.
Stream returned.
Stream not found.
An containing the channel stream on success,
or a if stream not found.
Localization controller.
Initializes a new instance of the class.
Instance of the interface.
Gets known cultures.
Known cultures returned.
An containing the list of cultures.
Gets known countries.
Known countries returned.
An containing the list of countries.
Gets known parental ratings.
Known parental ratings returned.
An containing the list of parental ratings.
Gets localization options.
Localization options returned.
An containing the list of localization options.
Lyrics controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets an item's lyrics.
Item id.
Lyrics returned.
Something went wrong. No Lyrics will be returned.
An containing the item's lyrics.
Upload an external lyric file.
The item the lyric belongs to.
Name of the file being uploaded.
Lyrics uploaded.
Error processing upload.
Item not found.
The uploaded lyric.
Deletes an external lyric file.
The item id.
Lyric deleted.
Item not found.
A .
Search remote lyrics.
The item id.
Lyrics retrieved.
Item not found.
An array of .
Downloads a remote lyric.
The item id.
The lyric id.
Lyric downloaded.
Item not found.
A .
Gets the remote lyrics.
The remote provider item id.
File returned.
Lyric not found.
A with the lyric file.
The media info controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the .
Instance of the interface..
Gets live playback media info for an item.
The item id.
The user id.
Playback info returned.
Item not found.
A containing a with the playback information.
Gets live playback media info for an item.
For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.
Query parameters are obsolete.
The item id.
The user id.
The maximum streaming bitrate.
The start time in ticks.
The audio stream index.
The subtitle stream index.
The maximum number of audio channels.
The media source id.
The livestream id.
Whether to auto open the livestream.
Whether to enable direct play. Default: true.
Whether to enable direct stream. Default: true.
Whether to enable transcoding. Default: true.
Whether to allow to copy the video stream. Default: true.
Whether to allow to copy the audio stream. Default: true.
The playback info.
Playback info returned.
Item not found.
A containing a with the playback info.
Opens a media source.
The open token.
The user id.
The play session id.
The maximum streaming bitrate.
The start time in ticks.
The audio stream index.
The subtitle stream index.
The maximum number of audio channels.
The item id.
The open live stream dto.
Whether to enable direct play. Default: true.
Whether to enable direct stream. Default: true.
Always burn-in subtitle when transcoding.
Media source opened.
A containing a .
Closes a media source.
The livestream id.
Livestream closed.
A indicating success.
Tests the network with a request with the size of the bitrate.
The bitrate. Defaults to 102400.
Test buffer returned.
A with specified bitrate.
Media Segments api.
Initializes a new instance of the class.
MediaSegments Manager.
The Library manager.
Gets all media segments based on an itemId.
The ItemId.
Optional filter of requested segment types.
A list of media segment objects related to the requested itemId.
Movies controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets movie recommendations.
Optional. Filter by user id, and attach user data.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. The fields to return.
The max number of categories to return.
The max number of items to return per category.
Movie recommendations returned.
The list of movie recommendations.
The music genres controller.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Instance of interface.
Gets all music genres from a given item, folder, or the entire library.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
The search term.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output.
Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited.
Optional filter by items that are marked as favorite, or not.
Optional, the max number of images to return, per image type.
Optional. The image types to include in the output.
User id.
Optional filter by items whose name is sorted equally or greater than a given input string.
Optional filter by items whose name is sorted equally than a given input string.
Optional filter by items whose name is equally or lesser than a given input string.
Optional. Specify one or more sort orders, comma delimited.
Sort Order - Ascending,Descending.
Optional, include image information in output.
Optional. Include total record count.
Music genres returned.
An containing the queryresult of music genres.
Gets a music genre, by name.
The genre name.
Optional. Filter by user id, and attach user data.
An containing a with the music genre.
Package Controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Gets a package by name or assembly GUID.
The name of the package.
The GUID of the associated assembly.
Package retrieved.
A containing package information.
Gets available packages.
Available packages returned.
An containing available packages information.
Installs a package.
Package name.
GUID of the associated assembly.
Optional version. Defaults to latest version.
Optional. Specify the repository to install from.
Package found.
Package not found.
A on success, or a if the package could not be found.
Cancels a package installation.
Installation Id.
Installation cancelled.
A on successfully cancelling a package installation.
Gets all package repositories.
Package repositories returned.
An containing the list of package repositories.
Sets the enabled and existing package repositories.
The list of package repositories.
Package repositories saved.
A .
Persons controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets all persons.
Optional. The maximum number of records to return.
The search term.
Optional. Specify additional fields of information to return in the output.
Optional. Specify additional filters to apply.
Optional filter by items that are marked as favorite, or not. userId is required.
Optional, include user data.
Optional, the max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited.
Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited.
Optional. If specified, person results will be filtered on items related to said persons.
User id.
Optional, include image information in output.
Persons returned.
An containing the queryresult of persons.
Get person by name.
Person name.
Optional. Filter by user id, and attach user data.
Person returned.
Person not found.
An containing the person on success,
or a if person not found.
Playlists controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Creates a new playlist.
For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.
Query parameters are obsolete.
The playlist name.
The item ids.
The user id.
The media type.
The create playlist payload.
Playlist created.
A that represents the asynchronous operation to create a playlist.
The task result contains an indicating success.
Updates a playlist.
The playlist id.
The id.
Playlist updated.
Access forbidden.
Playlist not found.
A that represents the asynchronous operation to update a playlist.
The task result contains an indicating success.
Get a playlist.
The playlist id.
The playlist.
Playlist not found.
A objects.
Get a playlist's users.
The playlist id.
Found shares.
Access forbidden.
Playlist not found.
A list of objects.
Get a playlist user.
The playlist id.
The user id.
User permission found.
Access forbidden.
Playlist not found.
.
Modify a user of a playlist's users.
The playlist id.
The user id.
The .
User's permissions modified.
Access forbidden.
Playlist not found.
A that represents the asynchronous operation to modify an user's playlist permissions.
The task result contains an indicating success.
Remove a user from a playlist's users.
The playlist id.
The user id.
User permissions removed from playlist.
Unauthorized access.
No playlist or user permissions found.
A that represents the asynchronous operation to delete a user from a playlist's shares.
The task result contains an indicating success.
Adds items to a playlist.
The playlist id.
Item id, comma delimited.
Optional. 0-based index where to place the items or at the end if null.
The userId.
Items added to playlist.
Access forbidden.
Playlist not found.
An on success.
Moves a playlist item.
The playlist id.
The item id.
The new index.
Item moved to new index.
Access forbidden.
Playlist not found.
An on success.
Removes items from a playlist.
The playlist id.
The item ids, comma delimited.
Items removed.
Access forbidden.
Playlist not found.
An on success.
Gets the original items of a playlist.
The playlist id.
User id.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output.
Optional. Include image information in output.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Original playlist returned.
Access forbidden.
Playlist not found.
The original playlist items.
Playstate controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Marks an item as played for user.
User id.
Item id.
Optional. The date the item was played.
Item marked as played.
Item not found.
An containing the , or a if item was not found.
Marks an item as played for user.
User id.
Item id.
Optional. The date the item was played.
Item marked as played.
Item not found.
An containing the , or a if item was not found.
Marks an item as unplayed for user.
User id.
Item id.
Item marked as unplayed.
Item not found.
A containing the , or a if item was not found.
Marks an item as unplayed for user.
User id.
Item id.
Item marked as unplayed.
Item not found.
A containing the , or a if item was not found.
Reports playback has started within a session.
The playback start info.
Playback start recorded.
A .
Reports playback progress within a session.
The playback progress info.
Playback progress recorded.
A .
Pings a playback session.
Playback session id.
Playback session pinged.
A .
Reports playback has stopped within a session.
The playback stop info.
Playback stop recorded.
A .
Reports that a session has begun playing an item.
Item id.
The id of the MediaSource.
The audio stream index.
The subtitle stream index.
The play method.
The live stream id.
The play session id.
Indicates if the client can seek.
Play start recorded.
A .
Reports that a user has begun playing an item.
User id.
Item id.
The id of the MediaSource.
The audio stream index.
The subtitle stream index.
The play method.
The live stream id.
The play session id.
Indicates if the client can seek.
Play start recorded.
A .
Reports a session's playback progress.
Item id.
The id of the MediaSource.
Optional. The current position, in ticks. 1 tick = 10000 ms.
The audio stream index.
The subtitle stream index.
Scale of 0-100.
The play method.
The live stream id.
The play session id.
The repeat mode.
Indicates if the player is paused.
Indicates if the player is muted.
Play progress recorded.
A .
Reports a user's playback progress.
User id.
Item id.
The id of the MediaSource.
Optional. The current position, in ticks. 1 tick = 10000 ms.
The audio stream index.
The subtitle stream index.
Scale of 0-100.
The play method.
The live stream id.
The play session id.
The repeat mode.
Indicates if the player is paused.
Indicates if the player is muted.
Play progress recorded.
A .
Reports that a session has stopped playing an item.
Item id.
The id of the MediaSource.
The next media type that will play.
Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms.
The live stream id.
The play session id.
Playback stop recorded.
A .
Reports that a user has stopped playing an item.
User id.
Item id.
The id of the MediaSource.
The next media type that will play.
Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms.
The live stream id.
The play session id.
Playback stop recorded.
A .
Updates the played status.
The user.
The item.
if set to true [was played].
The date played.
Task.
Plugins controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Gets a list of currently installed plugins.
Installed plugins returned.
List of currently installed plugins.
Enables a disabled plugin.
Plugin id.
Plugin version.
Plugin enabled.
Plugin not found.
An on success, or a if the plugin could not be found.
Disable a plugin.
Plugin id.
Plugin version.
Plugin disabled.
Plugin not found.
An on success, or a if the plugin could not be found.
Uninstalls a plugin by version.
Plugin id.
Plugin version.
Plugin uninstalled.
Plugin not found.
An on success, or a if the plugin could not be found.
Uninstalls a plugin.
Plugin id.
Plugin uninstalled.
Plugin not found.
An on success, or a if the plugin could not be found.
Gets plugin configuration.
Plugin id.
Plugin configuration returned.
Plugin not found or plugin configuration not found.
Plugin configuration.
Updates plugin configuration.
Accepts plugin configuration as JSON body.
Plugin id.
Plugin configuration updated.
Plugin not found or plugin does not have configuration.
An on success, or a if the plugin could not be found.
Gets a plugin's image.
Plugin id.
Plugin version.
Plugin image returned.
Plugin's image.
Gets a plugin's manifest.
Plugin id.
Plugin manifest returned.
Plugin not found.
A on success, or a if the plugin could not be found.
Quick connect controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Gets the current quick connect state.
Quick connect state returned.
Whether Quick Connect is enabled on the server or not.
Initiate a new quick connect request.
Quick connect request successfully created.
Quick connect is not active on this server.
A with a secret and code for future use or an error message.
Attempts to retrieve authentication information.
Secret previously returned from the Initiate endpoint.
Quick connect result returned.
Unknown quick connect secret.
An updated .
Authorizes a pending quick connect request.
Quick connect code to authorize.
The user the authorize. Access to the requested user is required.
Quick connect result authorized successfully.
Unknown user id.
Boolean indicating if the authorization was successful.
Remote Images Controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets available remote images for an item.
Item Id.
The image type.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. The image provider to use.
Optional. Include all languages.
Remote Images returned.
Item not found.
Remote Image Result.
Gets available remote image providers for an item.
Item Id.
Returned remote image providers.
Item not found.
List of remote image providers.
Downloads a remote image for an item.
Item Id.
The image type.
The image url.
Remote image downloaded.
Remote image not found.
Download status.
Gets the full cache path.
The filename.
System.String.
Scheduled Tasks Controller.
Initializes a new instance of the class.
Instance of the interface.
Get tasks.
Optional filter tasks that are hidden, or not.
Optional filter tasks that are enabled, or not.
Scheduled tasks retrieved.
The list of scheduled tasks.
Get task by id.
Task Id.
Task retrieved.
Task not found.
An containing the task on success, or a if the task could not be found.
Start specified task.
Task Id.
Task started.
Task not found.
An on success, or a if the file could not be found.
Stop specified task.
Task Id.
Task stopped.
Task not found.
An on success, or a if the file could not be found.
Update specified task triggers.
Task Id.
Triggers.
Task triggers updated.
Task not found.
An on success, or a if the file could not be found.
Search controller.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Instance of interface.
Instance of interface.
Gets the search hint result.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Supply a user id to search within a user's library or omit to search all.
The search term to filter on.
If specified, only results with the specified item types are returned. This allows multiple, comma delimited.
If specified, results with these item types are filtered out. This allows multiple, comma delimited.
If specified, only results with the specified media types are returned. This allows multiple, comma delimited.
If specified, only children of the parent are returned.
Optional filter for movies.
Optional filter for series.
Optional filter for news.
Optional filter for kids.
Optional filter for sports.
Optional filter whether to include people.
Optional filter whether to include media.
Optional filter whether to include genres.
Optional filter whether to include studios.
Optional filter whether to include artists.
Search hint returned.
An with the results of the search.
Gets the search hint result.
The hint info.
SearchHintResult.
The session controller.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Gets a list of sessions.
Filter by sessions that a given user is allowed to remote control.
Filter by device Id.
Optional. Filter by sessions that were active in the last n seconds.
List of sessions returned.
An with the available sessions.
Instructs a session to browse to an item or view.
The session Id.
The type of item to browse to.
The Id of the item.
The name of the item.
Instruction sent to session.
A .
Instructs a session to play an item.
The session id.
The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now.
The ids of the items to play, comma delimited.
The starting position of the first item.
Optional. The media source id.
Optional. The index of the audio stream to play.
Optional. The index of the subtitle stream to play.
Optional. The start index.
Instruction sent to session.
A .
Issues a playstate command to a client.
The session id.
The .
The optional position ticks.
The optional controlling user id.
Playstate command sent to session.
A .
Issues a system command to a client.
The session id.
The command to send.
System command sent to session.
A .
Issues a general command to a client.
The session id.
The command to send.
General command sent to session.
A .
Issues a full general command to a client.
The session id.
The .
Full general command sent to session.
A .
Issues a command to a client to display a message to the user.
The session id.
The object containing Header, Message Text, and TimeoutMs.
Message sent.
A .
Adds an additional user to a session.
The session id.
The user id.
User added to session.
A .
Removes an additional user from a session.
The session id.
The user id.
User removed from session.
A .
Updates capabilities for a device.
The session id.
A list of playable media types, comma delimited. Audio, Video, Book, Photo.
A list of supported remote control commands, comma delimited.
Determines whether media can be played remotely..
Determines whether the device supports a unique identifier.
Capabilities posted.
A .
Updates capabilities for a device.
The session id.
The .
Capabilities updated.
A .
Reports that a session is viewing an item.
The session id.
The item id.
Session reported to server.
A .
Reports that a session has ended.
Session end reported to server.
A .
Get all auth providers.
Auth providers retrieved.
An with the auth providers.
Get all password reset providers.
Password reset providers retrieved.
An with the password reset providers.
The startup wizard controller.
Initializes a new instance of the class.
The server configuration manager.
The user manager.
Completes the startup wizard.
Startup wizard completed.
A indicating success.
Gets the initial startup wizard configuration.
Initial startup wizard configuration retrieved.
An containing the initial startup wizard configuration.
Sets the initial startup wizard configuration.
The updated startup configuration.
Configuration saved.
A indicating success.
Sets remote access and UPnP.
The startup remote access dto.
Configuration saved.
A indicating success.
Gets the first user.
Initial user retrieved.
The first user.
Sets the user name and password.
The DTO containing username and password.
Updated user name and password.
A that represents the asynchronous update operation.
The task result contains a indicating success.
Studios controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets all studios from a given item, folder, or the entire library.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Search term.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output.
Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Optional filter by items that are marked as favorite, or not.
Optional, include user data.
Optional, the max number of images to return, per image type.
Optional. The image types to include in the output.
User id.
Optional filter by items whose name is sorted equally or greater than a given input string.
Optional filter by items whose name is sorted equally than a given input string.
Optional filter by items whose name is equally or lesser than a given input string.
Optional, include image information in output.
Total record count.
Studios returned.
An containing the studios.
Gets a studio by name.
Studio name.
Optional. Filter by user id, and attach user data.
Studio returned.
An containing the studio.
Subtitle controller.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Instance of interface.
Instance of interface.
Instance of interface.
Instance of interface.
Instance of interface.
Instance of interface.
Deletes an external subtitle file.
The item id.
The index of the subtitle file.
Subtitle deleted.
Item not found.
A .
Search remote subtitles.
The item id.
The language of the subtitles.
Optional. Only show subtitles which are a perfect match.
Subtitles retrieved.
Item not found.
An array of .
Downloads a remote subtitle.
The item id.
The subtitle id.
Subtitle downloaded.
Item not found.
A .
Gets the remote subtitles.
The item id.
File returned.
A with the subtitle file.
Gets subtitles in a specified format.
The (route) item id.
The (route) media source id.
The (route) subtitle stream index.
The (route) format of the returned subtitle.
The item id.
The media source id.
The subtitle stream index.
The format of the returned subtitle.
Optional. The end position of the subtitle in ticks.
Optional. Whether to copy the timestamps.
Optional. Whether to add a VTT time map.
The start position of the subtitle in ticks.
File returned.
A with the subtitle file.
Gets subtitles in a specified format.
The (route) item id.
The (route) media source id.
The (route) subtitle stream index.
The (route) start position of the subtitle in ticks.
The (route) format of the returned subtitle.
The item id.
The media source id.
The subtitle stream index.
The start position of the subtitle in ticks.
The format of the returned subtitle.
Optional. The end position of the subtitle in ticks.
Optional. Whether to copy the timestamps.
Optional. Whether to add a VTT time map.
File returned.
A with the subtitle file.
Gets an HLS subtitle playlist.
The item id.
The subtitle stream index.
The media source id.
The subtitle segment length.
Subtitle playlist retrieved.
Item not found.
A with the HLS subtitle playlist.
Upload an external subtitle file.
The item the subtitle belongs to.
The request body.
Subtitle uploaded.
Item not found.
A .
Encodes a subtitle in the specified format.
The media id.
The source media id.
The subtitle index.
The format to convert to.
The start position in ticks.
The end position in ticks.
Whether to copy the timestamps.
A with the new subtitle file.
Gets a list of available fallback font files.
Information retrieved.
An array of with the available font files.
Gets a fallback font file.
The name of the fallback font file to get.
Fallback font file retrieved.
The fallback font file.
The suggestions controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets suggestions.
The user id.
The media types.
The type.
Optional. The start index.
Optional. The limit.
Whether to enable the total record count.
Suggestions returned.
A with the suggestions.
Gets suggestions.
The user id.
The media types.
The type.
Optional. The start index.
Optional. The limit.
Whether to enable the total record count.
Suggestions returned.
A with the suggestions.
The sync play controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Create a new SyncPlay group.
The settings of the new group.
New group created.
An for the created group.
Join an existing SyncPlay group.
The group to join.
Group join successful.
A indicating success.
Leave the joined SyncPlay group.
Group leave successful.
A indicating success.
Gets all SyncPlay groups.
Groups returned.
An containing the available SyncPlay groups.
Gets a SyncPlay group by id.
The id of the group.
Group returned.
An for the requested group.
Request to set new playlist in SyncPlay group.
The new playlist to play in the group.
Queue update sent to all group members.
A indicating success.
Request to change playlist item in SyncPlay group.
The new item to play.
Queue update sent to all group members.
A indicating success.
Request to remove items from the playlist in SyncPlay group.
The items to remove.
Queue update sent to all group members.
A indicating success.
Request to move an item in the playlist in SyncPlay group.
The new position for the item.
Queue update sent to all group members.
A indicating success.
Request to queue items to the playlist of a SyncPlay group.
The items to add.
Queue update sent to all group members.
A indicating success.
Request unpause in SyncPlay group.
Unpause update sent to all group members.
A indicating success.
Request pause in SyncPlay group.
Pause update sent to all group members.
A indicating success.
Request stop in SyncPlay group.
Stop update sent to all group members.
A indicating success.
Request seek in SyncPlay group.
The new playback position.
Seek update sent to all group members.
A indicating success.
Notify SyncPlay group that member is buffering.
The player status.
Group state update sent to all group members.
A indicating success.
Notify SyncPlay group that member is ready for playback.
The player status.
Group state update sent to all group members.
A indicating success.
Request SyncPlay group to ignore member during group-wait.
The settings to set.
Member state updated.
A indicating success.
Request next item in SyncPlay group.
The current item information.
Next item update sent to all group members.
A indicating success.
Request previous item in SyncPlay group.
The current item information.
Previous item update sent to all group members.
A indicating success.
Request to set repeat mode in SyncPlay group.
The new repeat mode.
Play queue update sent to all group members.
A indicating success.
Request to set shuffle mode in SyncPlay group.
The new shuffle mode.
Play queue update sent to all group members.
A indicating success.
Update session ping.
The new ping.
Ping updated.
A indicating success.
The system controller.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Instance of interface.
Instance of interface.
Instance of interface.
Instance of interface.
Gets information about the server.
Information retrieved.
User does not have permission to retrieve information.
A with info about the system.
Gets information about the server.
Information retrieved.
User does not have permission to retrieve information.
A with info about the system.
Gets public information about the server.
Information retrieved.
A with public info about the system.
Pings the system.
Information retrieved.
The server name.
Restarts the application.
Server restarted.
User does not have permission to restart server.
No content. Server restarted.
Shuts down the application.
Server shut down.
User does not have permission to shutdown server.
No content. Server shut down.
Gets a list of available server log files.
Information retrieved.
User does not have permission to get server logs.
An array of with the available log files.
Gets information about the request endpoint.
Information retrieved.
User does not have permission to get endpoint information.
with information about the endpoint.
Gets a log file.
The name of the log file to get.
Log file retrieved.
User does not have permission to get log files.
Could not find a log file with the name.
The log file.
The time sync controller.
Gets the current UTC time.
Time returned.
An to sync the client and server time.
The trailers controller.
Initializes a new instance of the class.
Instance of .
Finds movies and trailers similar to a given trailer.
The user id supplied as query parameter; this is required when not using an API key.
Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
Optional filter by items with theme songs.
Optional filter by items with theme videos.
Optional filter by items with subtitles.
Optional filter by items with special features.
Optional filter by items with trailers.
Optional. Return items that are siblings of a supplied item.
Optional filter by parent index number.
Optional filter by items that have or do not have a parental rating.
Optional filter by items that are HD or not.
Optional filter by items that are 4K or not.
Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
Optional filter by items that are missing episodes or not.
Optional filter by items that are unaired episodes or not.
Optional filter by minimum community rating.
Optional filter by minimum critic rating.
Optional. The minimum premiere date. Format = ISO.
Optional. The minimum last saved date. Format = ISO.
Optional. The minimum last saved date for the current user. Format = ISO.
Optional. The maximum premiere date. Format = ISO.
Optional filter by items that have an overview or not.
Optional filter by items that have an IMDb id or not.
Optional filter by items that have a TMDb id or not.
Optional filter by items that have a TVDb id or not.
Optional filter for live tv movies.
Optional filter for live tv series.
Optional filter for live tv news.
Optional filter for live tv kids.
Optional filter for live tv sports.
Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
When searching within folders, this determines whether or not the search will be recursive. true/false.
Optional. Filter based on a search term.
Sort Order - Ascending, Descending.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
Optional filter by items that are marked as favorite, or not.
Optional filter by MediaType. Allows multiple, comma delimited.
Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
Optional filter by items that are played, or not.
Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
Optional, include user data.
Optional, the max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. If specified, results will be filtered to include only those containing the specified person.
Optional. If specified, results will be filtered to include only those containing the specified person id.
Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered to include only those containing the specified artist id.
Optional. If specified, results will be filtered to include only those containing the specified album artist id.
Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.
Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
Optional filter by items that are locked.
Optional filter by items that are placeholders.
Optional filter by items that have official ratings.
Whether or not to hide items behind their boxsets.
Optional. Filter by the minimum width of the item.
Optional. Filter by the minimum height of the item.
Optional. Filter by the maximum width of the item.
Optional. Filter by the maximum height of the item.
Optional filter by items that are 3D, or not.
Optional filter by Series Status. Allows multiple, comma delimited.
Optional filter by items whose name is sorted equally or greater than a given input string.
Optional filter by items whose name is sorted equally than a given input string.
Optional filter by items whose name is equally or lesser than a given input string.
Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
Optional. Enable the total record count.
Optional, include image information in output.
A with the trailers.
Trickplay controller.
Initializes a new instance of the class.
Instance of .
Instance of .
Gets an image tiles playlist for trickplay.
The item id.
The width of a single tile.
The media version id, if using an alternate version.
Tiles playlist returned.
A containing the trickplay playlist file.
Gets a trickplay tile image.
The item id.
The width of a single tile.
The index of the desired tile.
The media version id, if using an alternate version.
Tile image returned.
Tile image not found at specified index.
A containing the trickplay tiles image.
The tv shows controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets a list of next up episodes.
The user id of the user to get the next up episodes for.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output.
Optional. Filter by series id.
Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Include image information in output.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. Include user data.
Optional. Starting date of shows to show in Next Up section.
Whether to enable the total records count. Defaults to true.
Whether to include resumable episodes in next up results.
Whether to include watched episodes in next up results.
A with the next up episodes.
Gets a list of upcoming episodes.
The user id of the user to get the upcoming episodes for.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional. Specify additional fields of information to return in the output.
Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Include image information in output.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. Include user data.
A with the upcoming episodes.
Gets episodes for a tv season.
The series id.
The user id.
Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
Optional filter by season number.
Optional. Filter by season id.
Optional. Filter by items that are missing episodes or not.
Optional. Return items that are siblings of a supplied item.
Optional. Skip through the list until a given item is found.
Optional. The record index to start at. All items with a lower index will be dropped from the results.
Optional. The maximum number of records to return.
Optional, include image information in output.
Optional, the max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. Include user data.
Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
A with the episodes on success or a if the series was not found.
Gets seasons for a tv series.
The series id.
The user id.
Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
Optional. Filter by special season.
Optional. Filter by items that are missing episodes or not.
Optional. Return items that are siblings of a supplied item.
Optional. Include image information in output.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. Include user data.
A on success or a if the series was not found.
Applies the paging.
The items.
The start index.
The limit.
IEnumerable{BaseItem}.
The universal audio controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of .
Instance of .
Instance of .
Instance of the interface.
Gets an audio stream.
The item id.
Optional. The audio container.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. The user id.
Optional. The audio codec to transcode to.
Optional. The maximum number of audio channels.
Optional. The number of how many audio channels to transcode to.
Optional. The maximum streaming bitrate.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The container to transcode to.
Optional. The transcoding protocol.
Optional. The maximum audio sample rate.
Optional. The maximum audio bit depth.
Optional. Whether to enable remote media.
Optional. Whether to enable Audio Encoding.
Whether to enable redirection. Defaults to true.
Audio stream returned.
Redirected to remote audio stream.
Item not found.
A containing the audio file.
User controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets a list of users.
Optional filter by IsHidden=true or false.
Optional filter by IsDisabled=true or false.
Users returned.
An containing the users.
Gets a list of publicly visible users for display on a login screen.
Public users returned.
An containing the public users.
Gets a user by Id.
The user id.
User returned.
User not found.
An with information about the user or a if the user was not found.
Deletes a user.
The user id.
User deleted.
User not found.
A indicating success or a if the user was not found.
Authenticates a user.
The user id.
The password as plain text.
User authenticated.
Sha1-hashed password only is not allowed.
User not found.
A containing an .
Authenticates a user by name.
The request.
User authenticated.
A containing an with information about the new session.
Authenticates a user with quick connect.
The request.
User authenticated.
Missing token.
A containing an with information about the new session.
Updates a user's password.
The user id.
The request.
Password successfully reset.
User is not allowed to update the password.
User not found.
A indicating success or a or a on failure.
Updates a user's password.
The user id.
The request.
Password successfully reset.
User is not allowed to update the password.
User not found.
A indicating success or a or a on failure.
Updates a user.
The user id.
The updated user model.
User updated.
User information was not supplied.
User update forbidden.
A indicating success or a or a on failure.
Updates a user.
The user id.
The updated user model.
User updated.
User information was not supplied.
User update forbidden.
A indicating success or a or a on failure.
Updates a user policy.
The user id.
The new user policy.
User policy updated.
User policy was not supplied.
User policy update forbidden.
A indicating success or a or a on failure..
Updates a user configuration.
The user id.
The new user configuration.
User configuration updated.
User configuration update forbidden.
A indicating success.
Updates a user configuration.
The user id.
The new user configuration.
User configuration updated.
User configuration update forbidden.
A indicating success.
Creates a user.
The create user by name request body.
User created.
An of the new user.
Initiates the forgot password process for a local user.
The forgot password request containing the entered username.
Password reset process started.
A containing a .
Redeems a forgot password pin.
The forgot password pin request containing the entered pin.
Pin reset process started.
A containing a .
Gets the user based on auth token.
User returned.
Token is not owned by a user.
A for the authenticated user.
User library controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Gets an item from a user's library.
User id.
Item id.
Item returned.
An containing the item.
Gets an item from a user's library.
User id.
Item id.
Item returned.
An containing the item.
Gets the root folder from a user's library.
User id.
Root folder returned.
An containing the user's root folder.
Gets the root folder from a user's library.
User id.
Root folder returned.
An containing the user's root folder.
Gets intros to play before the main media item plays.
User id.
Item id.
Intros returned.
An containing the intros to play.
Gets intros to play before the main media item plays.
User id.
Item id.
Intros returned.
An containing the intros to play.
Marks an item as a favorite.
User id.
Item id.
Item marked as favorite.
An containing the .
Marks an item as a favorite.
User id.
Item id.
Item marked as favorite.
An containing the .
Unmarks item as a favorite.
User id.
Item id.
Item unmarked as favorite.
An containing the .
Unmarks item as a favorite.
User id.
Item id.
Item unmarked as favorite.
An containing the .
Deletes a user's saved personal rating for an item.
User id.
Item id.
Personal rating removed.
An containing the .
Deletes a user's saved personal rating for an item.
User id.
Item id.
Personal rating removed.
An containing the .
Updates a user's rating for an item.
User id.
Item id.
Whether this is likes.
Item rating updated.
An containing the .
Updates a user's rating for an item.
User id.
Item id.
Whether this is likes.
Item rating updated.
An containing the .
Gets local trailers for an item.
User id.
Item id.
An containing the item's local trailers.
The items local trailers.
Gets local trailers for an item.
User id.
Item id.
An containing the item's local trailers.
The items local trailers.
Gets special features for an item.
User id.
Item id.
Special features returned.
An containing the special features.
Gets special features for an item.
User id.
Item id.
Special features returned.
An containing the special features.
Gets latest media.
User id.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Filter by items that are played, or not.
Optional. include image information in output.
Optional. the max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. include user data.
Return item limit.
Whether or not to group items into a parent container.
Latest media returned.
An containing the latest media.
Gets latest media.
User id.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output.
Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
Filter by items that are played, or not.
Optional. include image information in output.
Optional. the max number of images to return, per image type.
Optional. The image types to include in the output.
Optional. include user data.
Return item limit.
Whether or not to group items into a parent container.
Latest media returned.
An containing the latest media.
Marks the favorite.
The user.
The item.
if set to true [is favorite].
Updates the user item rating.
The user.
The item.
if set to true [likes].
User views controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Get user views.
User id.
Whether or not to include external views such as channels or live tv.
Preset views.
Whether or not to include hidden content.
User views returned.
An containing the user views.
Get user views.
User id.
Whether or not to include external views such as channels or live tv.
Preset views.
Whether or not to include hidden content.
User views returned.
An containing the user views.
Get user view grouping options.
User id.
User view grouping options returned.
User not found.
An containing the user view grouping options
or a if user not found.
Get user view grouping options.
User id.
User view grouping options returned.
User not found.
An containing the user view grouping options
or a if user not found.
Attachments controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Get video attachment.
Video ID.
Media Source ID.
Attachment Index.
Attachment retrieved.
Video or attachment not found.
An containing the attachment stream on success, or a if the attachment could not be found.
The videos controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of .
Gets additional parts for a video.
The item id.
Optional. Filter by user id, and attach user data.
Additional parts returned.
A with the parts.
Removes alternate video sources.
The item id.
Alternate sources deleted.
Video not found.
A indicating success, or a if the video doesn't exist.
Merges videos into a single record.
Item id list. This allows multiple, comma delimited.
Videos merged.
Supply at least 2 video ids.
A indicating success, or a if less than two ids were supplied.
Gets a video stream.
The item id.
The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
The streaming parameters.
The tag.
Optional. The dlna device profile id to utilize.
The play session id.
The segment container.
The segment length.
The minimum number of segments.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.
Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
Whether or not to allow copying of the video stream url.
Whether or not to allow copying of the audio stream url.
Optional. Specify a specific audio sample rate, e.g. 44100.
Optional. The maximum audio bit depth.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a specific number of audio channels to encode to, e.g. 2.
Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The fixed horizontal resolution of the encoded video.
Optional. The fixed vertical resolution of the encoded video.
Optional. The maximum horizontal resolution of the encoded video.
Optional. The maximum vertical resolution of the encoded video.
Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
Optional. Specify the subtitle delivery method.
Optional.
Optional. The maximum video bit depth.
Optional. Whether to require avc.
Optional. Whether to deinterlace the video.
Optional. Whether to require a non anamorphic stream.
Optional. The maximum number of audio channels to transcode.
Optional. The limit of how many cpu cores to use.
The live stream id.
Optional. Whether to enable the MpegtsM2Ts mode.
Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.
Optional. Specify a subtitle codec to encode to.
Optional. The transcoding reason.
Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
Optional. The index of the video stream to use. If omitted the first video stream will be used.
Optional. The .
Optional. The streaming options.
Optional. Whether to enable Audio Encoding.
Video stream returned.
A containing the audio file.
Gets a video stream.
The item id.
The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
The streaming parameters.
The tag.
Optional. The dlna device profile id to utilize.
The play session id.
The segment container.
The segment length.
The minimum number of segments.
The media version id, if playing an alternate version.
The device id of the client requesting. Used to stop encoding processes when needed.
Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.
Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
Whether or not to allow copying of the video stream url.
Whether or not to allow copying of the audio stream url.
Optional. Specify a specific audio sample rate, e.g. 44100.
Optional. The maximum audio bit depth.
Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
Optional. Specify a specific number of audio channels to encode to, e.g. 2.
Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
Optional. The fixed horizontal resolution of the encoded video.
Optional. The fixed vertical resolution of the encoded video.
Optional. The maximum horizontal resolution of the encoded video.
Optional. The maximum vertical resolution of the encoded video.
Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
Optional. Specify the subtitle delivery method.
Optional.
Optional. The maximum video bit depth.
Optional. Whether to require avc.
Optional. Whether to deinterlace the video.
Optional. Whether to require a non anamorphic stream.
Optional. The maximum number of audio channels to transcode.
Optional. The limit of how many cpu cores to use.
The live stream id.
Optional. Whether to enable the MpegtsM2Ts mode.
Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.
Optional. Specify a subtitle codec to encode to.
Optional. The transcoding reason.
Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
Optional. The index of the video stream to use. If omitted the first video stream will be used.
Optional. The .
Optional. The streaming options.
Optional. Whether to enable Audio Encoding.
Video stream returned.
A containing the audio file.
Years controller.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Get years.
Skips over a given number of items within the results. Use for paging.
Optional. The maximum number of records to return.
Sort Order - Ascending,Descending.
Specify this to localize the search to a specific item or folder. Omit to use the root.
Optional. Specify additional fields of information to return in the output.
Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
Optional. Filter by MediaType. Allows multiple, comma delimited.
Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
Optional. Include user data.
Optional. The max number of images to return, per image type.
Optional. The image types to include in the output.
User Id.
Search recursively.
Optional. Include image information in output.
Year query returned.
A containing the year result.
Gets a year.
The year.
Optional. Filter by user id, and attach user data.
Year returned.
Year not found.
An containing the year,
or a if year not found.
Extensions for .
Get user id from claims.
Current claims principal.
User id.
Get device id from claims.
Current claims principal.
Device id.
Get device from claims.
Current claims principal.
Device.
Get client from claims.
Current claims principal.
Client.
Get version from claims.
Current claims principal.
Version.
Get token from claims.
Current claims principal.
Token.
Gets a flag specifying whether the request is using an api key.
Current claims principal.
The flag specifying whether the request is using an api key.
Dto Extensions.
Add additional DtoOptions.
Converted from IHasDtoOptions.
Legacy order: 3.
DtoOptions object.
Enable images.
Enable user data.
Image type limit.
Enable image types.
Modified DtoOptions object.
Camel Case Json Profile Formatter.
Initializes a new instance of the class.
Css output formatter.
Initializes a new instance of the class.
Pascal Case Json Profile Formatter.
Initializes a new instance of the class.
Xml output formatter.
Initializes a new instance of the class.
Audio helper.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of interface.
Instance of the interface.
Instance of the interface.
Instance of .
Get audio stream.
Transcoding job type.
Streaming controller.Request dto.
A containing the resulting .
Dynamic hls helper.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of .
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of .
Instance of .
Get master hls playlist.
Transcoding job type.
Streaming request dto.
Enable adaptive bitrate streaming.
A containing the resulting .
Appends a VIDEO-RANGE field containing the range of the output video stream.
StringBuilder to append the field to.
StreamState of the current stream.
Appends a CODECS field containing formatted strings of
the active streams output video and audio codecs.
StringBuilder to append the field to.
StreamState of the current stream.
Appends a SUPPLEMENTAL-CODECS field containing formatted strings of
the active streams output Dolby Vision Videos.
StringBuilder to append the field to.
StreamState of the current stream.
Appends a RESOLUTION field containing the resolution of the output stream.
StringBuilder to append the field to.
StreamState of the current stream.
Appends a FRAME-RATE field containing the framerate of the output stream.
StringBuilder to append the field to.
StreamState of the current stream.
Appends EXT-X-IMAGE-STREAM-INF playlists for each available trickplay resolution.
StreamState of the current stream.
Dictionary of widths to corresponding tiles info.
StringBuilder to append the field to.
Http user context.
Get the H.26X level of the output video stream.
StreamState of the current stream.
H.26X level of the output video stream.
Get the profile of the output video stream.
StreamState of the current stream.
Video codec.
Profile of the output video stream.
Gets a formatted string of the output audio codec, for use in the CODECS field.
StreamState of the current stream.
Formatted audio codec string.
Gets a formatted string of the output video codec, for use in the CODECS field.
StreamState of the current stream.
Video codec.
Video level.
Formatted video codec string.
The stream response helpers.
Returns a static file from a remote source.
The current .
The making the remote request.
The current http context.
A cancellation token that can be used to cancel the operation.
A containing the API response.
Returns a static file from the server.
The path to the file.
The content type of the file.
An the file.
Returns a transcoded file from the server.
The current .
Whether the current request is a HTTP HEAD request so only the headers get returned.
The current http context.
The singleton.
The command line arguments to start ffmpeg.
The .
The .
A containing the transcoded file.
Helpers to generate HLS codec strings according to
RFC 6381 section 3.3
and the MP4 Registration Authority.
Codec name for MP3.
Codec name for AC-3.
Codec name for E-AC-3.
Codec name for FLAC.
Codec name for ALAC.
Codec name for OPUS.
Codec name for TRUEHD.
Gets a MP3 codec string.
MP3 codec string.
Gets an AAC codec string.
AAC profile.
AAC codec string.
Gets an AC-3 codec string.
AC-3 codec string.
Gets an E-AC-3 codec string.
E-AC-3 codec string.
Gets an FLAC codec string.
FLAC codec string.
Gets an ALAC codec string.
ALAC codec string.
Gets an OPUS codec string.
OPUS codec string.
Gets an TRUEHD codec string.
TRUEHD codec string.
Gets an DTS codec string.
DTS profile.
DTS codec string.
Gets a H.264 codec string.
H.264 profile.
H.264 level.
H.264 string.
Gets a H.265 codec string.
H.265 profile.
H.265 level.
H.265 string.
Gets a VP9 codec string.
Video width.
Video height.
Video pixel format.
Video framerate.
Video bitDepth.
The VP9 codec string.
Gets an AV1 codec string.
AV1 profile.
AV1 level.
AV1 tier flag.
AV1 bit depth.
The AV1 codec string.
The hls helpers.
Waits for a minimum number of segments to be available.
The playlist string.
The segment count.
Instance of the interface.
The .
A indicating the waiting process.
Gets the #EXT-X-MAP string.
The output path of the file.
The .
Get a normal string or depends on OS.
The string text of #EXT-X-MAP.
Gets the hls playlist text.
The path to the playlist file.
The .
The playlist text as a string.
Media info helper.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Get playback info.
The item.
The user.
Media source id.
Live stream id.
A containing the .
SetDeviceSpecificData.
Item to set data for.
Media source info.
Device profile.
Current claims principal.
Max bitrate.
Start time ticks.
Media source id.
Audio stream index.
Subtitle stream index.
Max audio channels.
Play session id.
User id.
Enable direct play.
Enable direct stream.
Enable transcoding.
Allow video stream copy.
Allow audio stream copy.
Always burn-in subtitle when transcoding.
Requesting IP address.
Sort media source.
Playback info response.
Max bitrate.
Open media source.
Http Context.
Live stream request.
A containing the .
Normalize media source container.
Media source.
Device profile.
Dlna profile type.
Request Extensions.
Get Order By.
Sort By. Comma delimited string.
Sort Order. Comma delimited string.
Order By.
Checks if the user can access a user.
The for the current request.
The user id.
A whether the user can access the user.
Checks if the user can update an entry.
The for the current request.
The user id.
Whether to restrict the user preferences.
A whether the user can update the entry.
Get the session based on http request.
The session manager.
The user manager.
The http context.
The optional userid.
The session.
Session not found.
The streaming helpers.
Gets the current streaming state.
The .
The .
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Instance of .
Instance of the interface.
The .
The .
A containing the current .
Parses query parameters as StreamOptions.
The query string.
A containing the stream options.
Gets the output file extension.
The state.
The mediaSource.
System.String.
Gets the output file path for transcoding.
The current .
The file extension of the output file.
Instance of the interface.
The device id.
The play session id.
The complete file path, including the folder, for the transcoding file.
Parses the parameters.
The request.
Parses the container into its file extension.
The container.
Redirect requests without baseurl prefix to the baseurl prefixed URL.
Initializes a new instance of the class.
The next delegate in the pipeline.
The logger.
The application configuration.
Executes the middleware action.
The current HTTP context.
The server configuration manager.
The async task.
Exception Middleware.
Initializes a new instance of the class.
Next request delegate.
Instance of the interface.
Instance of the interface.
Instance of the interface.
Invoke request.
Request context.
Task.
Validates the IP of requests coming from local networks wrt. remote access.
Initializes a new instance of the class.
The next delegate in the pipeline.
The logger to log to.
Executes the middleware action.
The current HTTP context.
The network manager.
The async task.
URL decodes the querystring before binding.
Initializes a new instance of the class.
The next delegate in the pipeline.
Executes the middleware action.
The current HTTP context.
The async task.
Response time middleware.
Initializes a new instance of the class.
Next request delegate.
Instance of the interface.
Invoke request.
Request context.
Instance of the interface.
Task.
Redirect requests to robots.txt to web/robots.txt.
Initializes a new instance of the class.
The next delegate in the pipeline.
The logger.
Executes the middleware action.
The current HTTP context.
The async task.
Shows a custom message during server startup.
Initializes a new instance of the class.
The next delegate in the pipeline.
Executes the middleware action.
The current HTTP context.
The server application host.
The localization manager.
The async task.
Defines the .
Initializes a new instance of the class.
The instance.
Gets or sets a value indicating the url decoded .
WebSocket Authentication Middleware.
Extracts and validates API tokens from WebSocket query strings.
Initializes a new instance of the class.
The next delegate in the pipeline.
The logger.
Executes the middleware action.
The current HTTP context.
The authentication service.
The async task.
Authenticates WebSocket requests by extracting api_key from query string.
The HTTP context.
The authentication service.
The async task.
Extension methods for adding WebSocket authentication to the pipeline.
Adds WebSocket authentication to the application pipeline.
The application builder.
The updated application builder.
Handles WebSocket requests.
Initializes a new instance of the class.
The next delegate in the pipeline.
Executes the middleware action.
The current HTTP context.
The WebSocket connection manager.
The async task.
Comma delimited collection model binder.
Returns an empty array of specified type if there is no query parameter.
Initializes a new instance of the class.
Instance of the interface.
DateTime model binder.
Initializes a new instance of the class.
Instance of the interface.
Nullable enum model binder.
Initializes a new instance of the class.
Instance of the interface.
Nullable enum model binder provider.
Comma delimited collection model binder.
Returns an empty collection of specified type if there is no query parameter.
Initializes a new instance of the class.
Instance of the interface.
Client log document response dto.
Initializes a new instance of the class.
The file name.
Gets the resulting filename.
The configuration page info.
Initializes a new instance of the class.
Instance of interface.
Instance of interface.
Initializes a new instance of the class.
Gets or sets the name.
The name.
Gets or sets a value indicating whether the configurations page is enabled in the main menu.
Gets or sets the menu section.
Gets or sets the menu icon.
Gets or sets the display name.
Gets or sets the plugin id.
The plugin id.
Default directory browser info.
Gets or sets the path.
Validate path object.
Gets or sets a value indicating whether validate if path is writable.
Gets or sets the path.
Gets or sets is path file.
Library option info dto.
Gets or sets name.
Gets or sets a value indicating whether default enabled.
Library options result dto.
Gets or sets the metadata savers.
Gets or sets the metadata readers.
Gets or sets the subtitle fetchers.
Gets or sets the list of lyric fetchers.
Gets or sets the list of MediaSegment Providers.
Gets or sets the type options.
Library type options dto.
Gets or sets the type.
Gets or sets the metadata fetchers.
Gets or sets the image fetchers.
Gets or sets the supported image types.
Gets or sets the default image options.
Media Update Info Dto.
Gets or sets the list of updates.
The media update info path.
Gets or sets media path.
Gets or sets media update type.
Created, Modified, Deleted.
Add virtual folder dto.
Gets or sets library options.
Media Path dto.
Gets or sets the name of the library.
Gets or sets the path to add.
Gets or sets the path info.
Update library options dto.
Gets or sets the library item id.
Gets or sets library options.
Update library options dto.
Gets or sets the library name.
Gets or sets library folder path information.
Get programs dto.
Gets or sets the channels to return guide information for.
Gets or sets optional. Filter by user id.
Gets or sets the minimum premiere start date.
Gets or sets filter by programs that have completed airing, or not.
Gets or sets filter by programs that are currently airing, or not.
Gets or sets the maximum premiere start date.
Gets or sets the minimum premiere end date.
Gets or sets the maximum premiere end date.
Gets or sets filter for movies.
Gets or sets filter for series.
Gets or sets filter for news.
Gets or sets filter for kids.
Gets or sets filter for sports.
Gets or sets the record index to start at. All items with a lower index will be dropped from the results.
Gets or sets the maximum number of records to return.
Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate.
Gets or sets sort order.
Gets or sets the genres to return guide information for.
Gets or sets the genre ids to return guide information for.
Gets or sets include image information in output.
Gets or sets a value indicating whether retrieve total record count.
Gets or sets the max number of images to return, per image type.
Gets or sets the image types to include in the output.
Gets or sets include user data.
Gets or sets filter by series timer id.
Gets or sets filter by library series id.
Gets or sets specify additional fields of information to return in the output.
Set channel mapping dto.
Gets or sets the provider id.
Gets or sets the tuner channel id.
Gets or sets the provider channel id.
Open live stream dto.
Gets or sets the open token.
Gets or sets the user id.
Gets or sets the play session id.
Gets or sets the max streaming bitrate.
Gets or sets the start time in ticks.
Gets or sets the audio stream index.
Gets or sets the subtitle stream index.
Gets or sets the max audio channels.
Gets or sets the item id.
Gets or sets a value indicating whether to enable direct play.
Gets or sets a value indicating whether to enable direct stream.
Gets or sets a value indicating whether always burn in subtitles when transcoding.
Gets or sets the device profile.
Gets or sets the device play protocols.
Playback info dto.
Gets or sets the playback userId.
Gets or sets the max streaming bitrate.
Gets or sets the start time in ticks.
Gets or sets the audio stream index.
Gets or sets the subtitle stream index.
Gets or sets the max audio channels.
Gets or sets the media source id.
Gets or sets the live stream id.
Gets or sets the device profile.
Gets or sets a value indicating whether to enable direct play.
Gets or sets a value indicating whether to enable direct stream.
Gets or sets a value indicating whether to enable transcoding.
Gets or sets a value indicating whether to enable video stream copy.
Gets or sets a value indicating whether to allow audio stream copy.
Gets or sets a value indicating whether to auto open the live stream.
Gets or sets a value indicating whether always burn in subtitles when transcoding.
Create new playlist dto.
Gets or sets the name of the new playlist.
Gets or sets item ids to add to the playlist.
Gets or sets the user id.
Gets or sets the media type.
Gets or sets the playlist users.
Gets or sets a value indicating whether the playlist is public.
Update existing playlist dto. Fields set to `null` will not be updated and keep their current values.
Gets or sets the name of the new playlist.
Gets or sets item ids of the playlist.
Gets or sets the playlist users.
Gets or sets a value indicating whether the playlist is public.
Update existing playlist user dto. Fields set to `null` will not be updated and keep their current values.
Gets or sets a value indicating whether the user can edit the playlist.
The startup configuration DTO.
Gets or sets the server name.
Gets or sets UI language culture.
Gets or sets the metadata country code.
Gets or sets the preferred language for the metadata.
Startup remote access dto.
Gets or sets a value indicating whether enable remote access.
The startup user DTO.
Gets or sets the username.
Gets or sets the user's password.
The hls video request dto.
Gets or sets a value indicating whether enable adaptive bitrate streaming.
The hls video request dto.
Gets or sets a value indicating whether enable adaptive bitrate streaming.
Upload subtitles dto.
Gets or sets the subtitle language.
Gets or sets the subtitle format.
Gets or sets a value indicating whether the subtitle is forced.
Gets or sets a value indicating whether the subtitle is for hearing impaired.
Gets or sets the subtitle data.
Class BufferRequestDto.
Initializes a new instance of the class.
Gets or sets when the request has been made by the client.
The date of the request.
Gets or sets the position ticks.
The position ticks.
Gets or sets a value indicating whether the client playback is unpaused.
The client playback status.
Gets or sets the playlist item identifier of the playing item.
The playlist item identifier.
Class IgnoreWaitRequestDto.
Gets or sets a value indicating whether the client should be ignored.
The client group-wait status.
Class JoinGroupRequestDto.
Gets or sets the group identifier.
The identifier of the group to join.
Class MovePlaylistItemRequestDto.
Initializes a new instance of the class.
Gets or sets the playlist identifier of the item.
The playlist identifier of the item.
Gets or sets the new position.
The new position.
Class NewGroupRequestDto.
Initializes a new instance of the class.
Gets or sets the group name.
The name of the new group.
Class NextItemRequestDto.
Initializes a new instance of the class.
Gets or sets the playing item identifier.
The playing item identifier.
Class PingRequestDto.
Gets or sets the ping time.
The ping time.
Class PlayRequestDto.
Initializes a new instance of the class.
Gets or sets the playing queue.
The playing queue.
Gets or sets the position of the playing item in the queue.
The playing item position.
Gets or sets the start position ticks.
The start position ticks.
Class PreviousItemRequestDto.
Initializes a new instance of the class.
Gets or sets the playing item identifier.
The playing item identifier.
Class QueueRequestDto.
Initializes a new instance of the class.
Gets or sets the items to enqueue.
The items to enqueue.
Gets or sets the mode in which to add the new items.
The enqueue mode.
Class ReadyRequest.
Initializes a new instance of the class.
Gets or sets when the request has been made by the client.
The date of the request.
Gets or sets the position ticks.
The position ticks.
Gets or sets a value indicating whether the client playback is unpaused.
The client playback status.
Gets or sets the playlist item identifier of the playing item.
The playlist item identifier.
Class RemoveFromPlaylistRequestDto.
Initializes a new instance of the class.
Gets or sets the playlist identifiers of the items. Ignored when clearing the playlist.
The playlist identifiers of the items.
Gets or sets a value indicating whether the entire playlist should be cleared.
Whether the entire playlist should be cleared.
Gets or sets a value indicating whether the playing item should be removed as well. Used only when clearing the playlist.
Whether the playing item should be removed as well.
Class SeekRequestDto.
Gets or sets the position ticks.
The position ticks.
Class SetPlaylistItemRequestDto.
Initializes a new instance of the class.
Gets or sets the playlist identifier of the playing item.
The playlist identifier of the playing item.
Class SetRepeatModeRequestDto.
Gets or sets the repeat mode.
The repeat mode.
Class SetShuffleModeRequestDto.
Gets or sets the shuffle mode.
The shuffle mode.
Contains information about a specific folder.
Gets the path of the folder in question.
Gets the free space of the underlying storage device of the .
Gets the used space of the underlying storage device of the .
Gets the kind of storage device of the .
Gets the Device Identifier.
Contains informations about a libraries storage informations.
Gets or sets the Library Id.
Gets or sets the name of the library.
Gets or sets the storage informations about the folders used in a library.
Contains informations about the systems storage.
Gets or sets the Storage information of the program data folder.
Gets or sets the Storage information of the web UI resources folder.
Gets or sets the Storage information of the folder where images are cached.
Gets or sets the Storage information of the cache folder.
Gets or sets the Storage information of the folder where logfiles are saved to.
Gets or sets the Storage information of the folder where metadata is stored.
Gets or sets the Storage information of the transcoding cache.
Gets or sets the storage informations of all libraries.
The authenticate user by name request body.
Gets or sets the username.
Gets or sets the plain text password.
The create user by name request body.
Gets or sets the username.
Gets or sets the password.
Forgot Password request body DTO.
Gets or sets the entered username to have its password reset.
Forgot Password Pin enter request body DTO.
Gets or sets the entered pin to have the password reset.
The quick connect request body.
Gets or sets the quick connect secret.
The update user password request body.
Gets or sets the current sha1-hashed password.
Gets or sets the current plain text password.
Gets or sets the new plain text password.
Gets or sets a value indicating whether to reset the password.
Special view option dto.
Gets or sets view option name.
Gets or sets view option id.
Ok result with type specified.
The type to return.
Initializes a new instance of the class.
The value to return.
Class ActivityLogWebSocketListener.
The _kernel.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Gets the data to send.
Task{SystemInfo}.
Starts sending messages over an activity log web socket.
The message.
Class ScheduledTasksWebSocketListener.
Gets or sets the task manager.
The task manager.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Gets the data to send.
Task{IEnumerable{TaskInfo}}.
Class SessionInfoWebSocketListener.
Initializes a new instance of the class.
Instance of the interface.
Instance of the interface.
Gets the data to send.
Task{SystemInfo}.
Starts sending messages over a session info web socket.
The message.