MediaBrowser.Model
An activity log entry.
Initializes a new instance of the class.
The name.
The type.
The user id.
Gets or sets the identifier.
The identifier.
Gets or sets the name.
The name.
Gets or sets the overview.
The overview.
Gets or sets the short overview.
The short overview.
Gets or sets the type.
The type.
Gets or sets the item identifier.
The item identifier.
Gets or sets the date.
The date.
Gets or sets the user identifier.
The user identifier.
Gets or sets the user primary image tag.
The user primary image tag.
Gets or sets the log severity.
The log severity.
Interface for the activity manager.
The event that is triggered when an entity is created.
Create a new activity log entry.
The entry to create.
A representing the asynchronous operation.
Get a paged list of activity log entries.
The activity log query.
The page of entries.
Remove all activity logs before the specified date.
Activity log start date.
A representing the asynchronous operation.
The server discovery info model.
Initializes a new instance of the class.
The server address.
The server id.
The server name.
The endpoint address.
Gets the address.
Gets the server identifier.
Gets the name.
Gets the endpoint address.
The branding options.
Gets or sets the login disclaimer.
The login disclaimer.
Gets or sets the custom CSS.
The custom CSS.
Gets or sets a value indicating whether to enable the splashscreen.
Gets or sets the splashscreen location on disk.
The branding options DTO for API use.
This DTO excludes SplashscreenLocation to prevent it from being updated via API.
Gets or sets the login disclaimer.
The login disclaimer.
Gets or sets the custom CSS.
The custom CSS.
Gets or sets a value indicating whether to enable the splashscreen.
Gets or sets the name.
The name.
Gets or sets the identifier.
The identifier.
Gets or sets a value indicating whether this instance can search.
true if this instance can search; otherwise, false.
Gets or sets the media types.
The media types.
Gets or sets the content types.
The content types.
Gets or sets the maximum number of records the channel allows retrieving at a time.
Gets or sets the automatic refresh levels.
The automatic refresh levels.
Gets or sets the default sort orders.
The default sort orders.
Gets or sets a value indicating whether a sort ascending/descending toggle is supported.
Gets or sets a value indicating whether [supports latest media].
true if [supports latest media]; otherwise, false.
Gets or sets a value indicating whether this instance can filter.
true if this instance can filter; otherwise, false.
Gets or sets a value indicating whether [supports content downloading].
true if [supports content downloading]; otherwise, false.
Gets or sets the fields to return within the items, in addition to basic information.
The fields.
Gets or sets the user identifier.
The user identifier.
Gets or sets the start index. Use for paging.
The start index.
Gets or sets the maximum number of items to return.
The limit.
Gets or sets a value indicating whether [supports latest items].
true if [supports latest items]; otherwise, false.
Gets or sets a value indicating whether this instance is favorite.
null if [is favorite] contains no value, true if [is favorite]; otherwise, false.
Serves as a common base class for the Server and UI application Configurations
ProtoInclude tells Protobuf about subclasses,
The number 50 can be any number, so long as it doesn't clash with any of the ProtoMember numbers either here or in subclasses.
Initializes a new instance of the class.
Gets or sets the number of days we should retain log files.
The log file retention days.
Gets or sets a value indicating whether this instance is first run.
true if this instance is first run; otherwise, false.
Gets or sets the cache path.
The cache path.
Gets or sets the last known version that was ran using the configuration.
The version from previous run.
Gets or sets the stringified PreviousVersion to be stored/loaded,
because System.Version itself isn't xml-serializable.
String value of PreviousVersion.
An enum representing the options to disable embedded subs.
Allow all embedded subs.
Allow only embedded subs that are text based.
Allow only embedded subs that are image based.
Disable all embedded subs.
Class EncodingOptions.
Initializes a new instance of the class.
Gets or sets the thread count used for encoding.
Gets or sets the temporary transcoding path.
Gets or sets the path to the fallback font.
Gets or sets a value indicating whether to use the fallback font.
Gets or sets a value indicating whether audio VBR is enabled.
Gets or sets the audio boost applied when downmixing audio.
Gets or sets the algorithm used for downmixing audio to stereo.
Gets or sets the maximum size of the muxing queue.
Gets or sets a value indicating whether throttling is enabled.
Gets or sets the delay after which throttling happens.
Gets or sets a value indicating whether segment deletion is enabled.
Gets or sets seconds for which segments should be kept before being deleted.
Gets or sets the hardware acceleration type.
Gets or sets the FFmpeg path as set by the user via the UI.
Gets or sets the current FFmpeg path being used by the system and displayed on the transcode page.
Gets or sets the VA-API device.
Gets or sets the QSV device.
Gets or sets a value indicating whether tonemapping is enabled.
Gets or sets a value indicating whether VPP tonemapping is enabled.
Gets or sets a value indicating whether videotoolbox tonemapping is enabled.
Gets or sets the tone-mapping algorithm.
Gets or sets the tone-mapping mode.
Gets or sets the tone-mapping range.
Gets or sets the tone-mapping desaturation.
Gets or sets the tone-mapping peak.
Gets or sets the tone-mapping parameters.
Gets or sets the VPP tone-mapping brightness.
Gets or sets the VPP tone-mapping contrast.
Gets or sets the H264 CRF.
Gets or sets the H265 CRF.
Gets or sets the encoder preset.
Gets or sets a value indicating whether the framerate is doubled when deinterlacing.
Gets or sets the deinterlace method.
Gets or sets a value indicating whether 10bit HEVC decoding is enabled.
Gets or sets a value indicating whether 10bit VP9 decoding is enabled.
Gets or sets a value indicating whether 8/10bit HEVC RExt decoding is enabled.
Gets or sets a value indicating whether 12bit HEVC RExt decoding is enabled.
Gets or sets a value indicating whether the enhanced NVDEC is enabled.
Gets or sets a value indicating whether the system native hardware decoder should be used.
Gets or sets a value indicating whether the Intel H264 low-power hardware encoder should be used.
Gets or sets a value indicating whether the Intel HEVC low-power hardware encoder should be used.
Gets or sets a value indicating whether hardware encoding is enabled.
Gets or sets a value indicating whether HEVC encoding is enabled.
Gets or sets a value indicating whether AV1 encoding is enabled.
Gets or sets a value indicating whether subtitle extraction is enabled.
Gets or sets the timeout for subtitle extraction in minutes.
Gets or sets the codecs hardware encoding is used for.
Gets or sets the file extensions on-demand metadata based keyframe extraction is enabled for.
Gets or sets the method used for audio seeking in HLS.
An enum representing the options to seek the input audio stream when
transcoding HLS segments.
If the video stream is transcoded and the audio stream is copied,
seek the video stream to the same keyframe as the audio stream. The
resulting timestamps in the output streams may be inaccurate.
Prevent audio streams from being copied if the video stream is transcoded.
The resulting timestamps will be accurate, but additional audio transcoding
overhead will be incurred.
Gets or sets the type.
The type.
Gets or sets the limit.
The limit.
Gets or sets the minimum width.
The minimum width.
Gets or sets the preferred metadata language.
The preferred metadata language.
Gets or sets the metadata country code.
The metadata country code.
Class MetadataOptions.
Gets or sets the name.
The name.
Gets or sets the type.
The type.
Gets or sets the type of the item.
The type of the item.
Gets or sets the plugins.
The plugins.
Gets or sets the supported image types.
The supported image types.
Enum MetadataPluginType.
Defines the .
Gets or sets the value to substitute.
Gets or sets the value to substitution with.
Represents the server configuration.
Initializes a new instance of the class.
Gets or sets a value indicating whether to enable prometheus metrics exporting.
Gets or sets a value indicating whether this instance is port authorized.
true if this instance is port authorized; otherwise, false.
Gets or sets a value indicating whether quick connect is available for use on this server.
Gets or sets a value indicating whether [enable case-sensitive item ids].
true if [enable case-sensitive item ids]; otherwise, false.
Gets or sets the metadata path.
The metadata path.
Gets or sets the preferred metadata language.
The preferred metadata language.
Gets or sets the metadata country code.
The metadata country code.
Gets or sets characters to be replaced with a ' ' in strings to create a sort name.
The sort replace characters.
Gets or sets characters to be removed from strings to create a sort name.
The sort remove characters.
Gets or sets words to be removed from strings to create a sort name.
The sort remove words.
Gets or sets the minimum percentage of an item that must be played in order for playstate to be updated.
The min resume PCT.
Gets or sets the maximum percentage of an item that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched.
The max resume PCT.
Gets or sets the minimum duration that an item must have in order to be eligible for playstate updates..
The min resume duration seconds.
Gets or sets the minimum minutes of a book that must be played in order for playstate to be updated.
The min resume in minutes.
Gets or sets the remaining minutes of a book that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched.
The remaining time in minutes.
Gets or sets the threshold in minutes after a inactive session gets closed automatically.
If set to 0 the check for inactive sessions gets disabled.
The close inactive session threshold in minutes. 0 to disable.
Gets or sets the delay in seconds that we will wait after a file system change to try and discover what has been added/removed
Some delay is necessary with some items because their creation is not atomic. It involves the creation of several
different directories and files.
The file watcher delay.
Gets or sets the duration in seconds that we will wait after a library updated event before executing the library changed notification.
The library update duration.
Gets or sets the maximum amount of items to cache.
Gets or sets the image saving convention.
The image saving convention.
Gets or sets a value indicating whether slow server responses should be logged as a warning.
Gets or sets the threshold for the slow response time warning in ms.
Gets or sets the cors hosts.
Gets or sets the number of days we should retain activity logs.
Gets or sets the how the library scan fans out.
Gets or sets the how many metadata refreshes can run concurrently.
Gets or sets a value indicating whether clients should be allowed to upload logs.
Gets or sets the dummy chapter duration in seconds, use 0 (zero) or less to disable generation altogether.
The dummy chapters duration.
Gets or sets the chapter image resolution.
The chapter image resolution.
Gets or sets the limit for parallel image encoding.
The limit for parallel image encoding.
Gets or sets the list of cast receiver applications.
Gets or sets the trickplay options.
The trickplay options.
Gets or sets a value indicating whether old authorization methods are allowed.
Class TrickplayOptions.
Gets or sets a value indicating whether or not to use HW acceleration.
Gets or sets a value indicating whether or not to use HW accelerated MJPEG encoding.
Gets or sets a value indicating whether to only extract key frames.
Significantly faster, but is not compatible with all decoders and/or video files.
Gets or sets the behavior used by trickplay provider on library scan/update.
Gets or sets the process priority for the ffmpeg process.
Gets or sets the interval, in ms, between each new trickplay image.
Gets or sets the target width resolutions, in px, to generates preview images for.
Gets or sets number of tile images to allow in X dimension.
Gets or sets number of tile images to allow in Y dimension.
Gets or sets the ffmpeg output quality level.
Gets or sets the jpeg quality to use for image tiles.
Gets or sets the number of threads to be used by ffmpeg.
Enum TrickplayScanBehavior.
Starts generation, only return once complete.
Start generation, return immediately.
Class UserConfiguration.
Initializes a new instance of the class.
Gets or sets the audio language preference.
The audio language preference.
Gets or sets a value indicating whether [play default audio track].
true if [play default audio track]; otherwise, false.
Gets or sets the subtitle language preference.
The subtitle language preference.
Gets or sets the id of the selected cast receiver.
Class containing global constants for Jellyfin Cryptography.
The default length for new salts.
The default output length.
The default amount of iterations for hashing passwords.
Creates a new instance.
The password that will be hashed.
A instance with the hash method, hash, salt and number of iterations.
Gets the symbolic name for the function used.
Returns the symbolic name for the function used.
Gets the additional parameters used by the hash function.
Gets the salt used for hashing the password.
Returns the salt used for hashing the password.
Gets the hashed password.
Return the hashed password.
A class for device Information.
Initializes a new instance of the class.
Gets or sets the name.
The name.
Gets or sets the custom name.
The custom name.
Gets or sets the access token.
The access token.
Gets or sets the identifier.
The identifier.
Gets or sets the last name of the user.
The last name of the user.
Gets or sets the name of the application.
The name of the application.
Gets or sets the application version.
The application version.
Gets or sets the last user identifier.
The last user identifier.
Gets or sets the date last modified.
The date last modified.
Gets or sets the capabilities.
The capabilities.
Gets or sets the icon URL.
The icon URL.
Defines the .
Initializes a new instance of the class.
Gets or sets the which this container must meet.
Gets or sets the list of which this profile must meet.
Gets or sets the list of to apply if this profile is met.
Gets or sets the codec(s) that this profile applies to.
Gets or sets the container(s) which this profile will be applied to.
Gets or sets the sub-container(s) which this profile will be applied to.
Checks to see whether the codecs and containers contain the given parameters.
The codec to match (single codec or comma-separated list).
The container to match.
When true and Container is "hls", uses SubContainer instead of Container for matching.
True if both the codec and container conditions are met.
Checks to see whether the codecs and containers contain the given parameters.
The list of codecs to match.
The container to match.
When true and Container is "hls", uses SubContainer instead of Container for matching.
True if both the codec and container conditions are met.
The condition processor.
Checks if a video condition is satisfied.
The .
The width.
The height.
The bit depth.
The bitrate.
The video profile.
The .
The video level.
The framerate.
The packet length.
The .
A value indicating whether the video is anamorphic.
A value indicating whether the video is interlaced.
The reference frames.
The number of streams.
The number of video streams.
The number of audio streams.
The video codec tag.
A value indicating whether the video is AVC.
True if the condition is satisfied.
Checks if a image condition is satisfied.
The .
The width.
The height.
True if the condition is satisfied.
Checks if an audio condition is satisfied.
The .
The channel count.
The bitrate.
The sample rate.
The bit depth.
True if the condition is satisfied.
Checks if an audio condition is satisfied for a video.
The .
The channel count.
The bitrate.
The sample rate.
The bit depth.
The profile.
A value indicating whether the audio is a secondary track.
True if the condition is satisfied.
Defines the .
Gets or sets the which this container must meet.
Gets or sets the list of which this container will be applied to.
Gets or sets the container(s) which this container must meet.
Gets or sets the sub container(s) which this container must meet.
Returns true if an item in appears in the property.
The item to match.
Consider subcontainers.
The result of the operation.
A represents a set of metadata which determines which content a certain device is able to play.
Specifically, it defines the supported containers and
codecs (video and/or audio, including codec profiles and levels)
the device is able to direct play (without transcoding or remuxing),
as well as which containers/codecs to transcode to in case it isn't.
Gets or sets the name of this device profile. User profiles must have a unique name.
Gets or sets the unique internal identifier.
Gets or sets the maximum allowed bitrate for all streamed content.
Gets or sets the maximum allowed bitrate for statically streamed content (= direct played files).
Gets or sets the maximum allowed bitrate for transcoded music streams.
Gets or sets the maximum allowed bitrate for statically streamed (= direct played) music files.
Gets or sets the direct play profiles.
Gets or sets the transcoding profiles.
Gets or sets the container profiles. Failing to meet these optional conditions causes transcoding to occur.
Gets or sets the codec profiles.
Gets or sets the subtitle profiles.
Defines the .
Gets or sets the container.
Gets or sets the audio codec.
Gets or sets the video codec.
Gets or sets the Dlna profile type.
Returns whether the supports the .
The container to match against.
True if supported.
Returns whether the supports the .
The codec to match against.
True if supported.
Returns whether the supports the .
The codec to match against.
True if supported.
Class MediaOptions.
Initializes a new instance of the class.
Gets or sets a value indicating whether direct playback is allowed.
Gets or sets a value indicating whether direct streaming is allowed.
Gets or sets a value indicating whether direct playback is forced.
Gets or sets a value indicating whether direct streaming is forced.
Gets or sets a value indicating whether audio stream copy is allowed.
Gets or sets a value indicating whether video stream copy is allowed.
Gets or sets a value indicating whether always burn in subtitles when transcoding.
Gets or sets the item id.
Gets or sets the media sources.
Gets or sets the device profile.
Gets or sets a media source id. Optional. Only needed if a specific AudioStreamIndex or SubtitleStreamIndex are requested.
Gets or sets the device id.
Gets or sets an override of supported number of audio channels
Example: DeviceProfile supports five channel, but user only has stereo speakers.
Gets or sets the application's configured maximum bitrate.
Gets or sets the context.
The context.
Gets or sets the audio transcoding bitrate.
The audio transcoding bitrate.
Gets or sets an override for the audio stream index.
Gets or sets an override for the subtitle stream index.
Gets the maximum bitrate.
Whether or not this is audio.
System.Nullable<System.Int32>.
Initializes a new instance of the class.
The maximum width.
The maximum bitrate.
Normalizes resolution options based on bitrate and dimensions.
The input bitrate.
The output bitrate.
The H264 equivalent output bitrate.
The maximum width.
The maximum height.
The target frames per second.
Whether the content is HDR.
The normalized resolution options.
Class StreamBuilder.
Initializes a new instance of the class.
The object.
The object.
Gets the optimal audio stream.
The object to get the audio stream from.
The of the optimal audio stream.
Gets the optimal video stream.
The object to get the video stream from.
The of the optimal video stream.
Normalizes input container.
The input container.
The .
The .
The object to get the video stream from.
The normalized input container.
Normalizes input container.
The .
The of the subtitle stream.
The list of supported s.
The .
The .
The output container.
The subtitle transcoding protocol.
The normalized input container.
Check the profile conditions.
Profile conditions.
Media source.
Video stream.
Failed profile conditions.
Check the compatibility of the container.
Media options.
Media source.
Container.
Video stream.
Transcode reasons if the container is not fully compatible.
Check the compatibility of the video codec.
Media options.
Media source.
Container.
Video stream.
Transcode reasons if the video stream is not fully compatible.
Check the compatibility of the audio codec.
Media options.
Media source.
Container.
Audio stream.
Override audio codec.
The media source is video.
The audio stream is secondary.
Transcode reasons if the audio stream is not fully compatible.
Check the compatibility of the audio codec for direct playback.
Media options.
Media source.
Container.
Audio stream.
The media source is video.
The audio stream is secondary.
Transcode reasons if the audio stream is not fully compatible for direct playback.
Class holding information on a stream.
Initializes a new instance of the class.
Gets or sets the item id.
The item id.
Gets or sets the play method.
The play method.
Gets or sets the encoding context.
The encoding context.
Gets or sets the media type.
The media type.
Gets or sets the container.
The container.
Gets or sets the sub protocol.
The sub protocol.
Gets or sets the start position ticks.
The start position ticks.
Gets or sets the segment length.
The segment length.
Gets or sets the minimum segments count.
The minimum segments count.
Gets or sets a value indicating whether the stream requires AVC.
Gets or sets a value indicating whether the stream requires AVC.
Gets or sets a value indicating whether timestamps should be copied.
Gets or sets a value indicating whether timestamps should be copied.
Gets or sets a value indicating whether the subtitle manifest is enabled.
Gets or sets the audio codecs.
The audio codecs.
Gets or sets the video codecs.
The video codecs.
Gets or sets the audio stream index.
The audio stream index.
Gets or sets the video stream index.
The subtitle stream index.
Gets or sets the maximum transcoding audio channels.
The maximum transcoding audio channels.
Gets or sets the global maximum audio channels.
The global maximum audio channels.
Gets or sets the audio bitrate.
The audio bitrate.
Gets or sets the audio sample rate.
The audio sample rate.
Gets or sets the video bitrate.
The video bitrate.
Gets or sets the maximum output width.
The output width.
Gets or sets the maximum output height.
The maximum output height.
Gets or sets the maximum framerate.
The maximum framerate.
Gets or sets the device profile.
The device profile.
Gets or sets the device profile id.
The device profile id.
Gets or sets the device id.
The device id.
Gets or sets the runtime ticks.
The runtime ticks.
Gets or sets the transcode seek info.
The transcode seek info.
Gets or sets a value indicating whether content length should be estimated.
Gets or sets the media source info.
The media source info.
Gets or sets the subtitle codecs.
The subtitle codecs.
Gets or sets the subtitle delivery method.
The subtitle delivery method.
Gets or sets the subtitle format.
The subtitle format.
Gets or sets the play session id.
The play session id.
Gets or sets the transcode reasons.
The transcode reasons.
Gets the stream options.
The stream options.
Gets the media source id.
The media source id.
Gets or sets a value indicating whether audio VBR encoding is enabled.
Gets or sets a value indicating whether always burn in subtitles when transcoding.
Gets a value indicating whether the stream is direct.
Gets the audio stream that will be used in the output stream.
The audio stream.
Gets the video stream that will be used in the output stream.
The video stream.
Gets the audio sample rate that will be in the output stream.
The target audio sample rate.
Gets the audio bit depth that will be in the output stream.
The target bit depth.
Gets the video bit depth that will be in the output stream.
The target video bit depth.
Gets the target reference frames that will be in the output stream.
The target reference frames.
Gets the target framerate that will be in the output stream.
The target framerate.
Gets the target video level that will be in the output stream.
The target video level.
Gets the target packet length that will be in the output stream.
The target packet length.
Gets the target video profile that will be in the output stream.
The target video profile.
Gets the target video range type that will be in the output stream.
The video range type.
Gets the target video codec tag.
The video codec tag.
Gets the audio bitrate that will be in the output stream.
The audio bitrate.
Gets the amount of audio channels that will be in the output stream.
The target audio channels.
Gets the audio codec that will be in the output stream.
The audio codec.
Gets the video codec that will be in the output stream.
The target video codec.
Gets the target size of the output stream.
The target size.
Gets the target video bitrate of the output stream.
The video bitrate.
Gets the target timestamp of the output stream.
The target timestamp.
Gets the target total bitrate of the output stream.
The target total bitrate.
Gets a value indicating whether the output stream is anamorphic.
Gets a value indicating whether the output stream is interlaced.
Gets a value indicating whether the output stream is AVC.
Gets the target width of the output stream.
The target width.
Gets the target height of the output stream.
The target height.
Gets the target video stream count of the output stream.
The target video stream count.
Gets the target audio stream count of the output stream.
The target audio stream count.
Sets a stream option.
The qualifier.
The name.
The value.
Sets a stream option.
The name.
The value.
Gets a stream option.
The qualifier.
The name.
The value.
Gets a stream option.
The name.
The value.
Returns this output stream URL for this class.
The base Url.
The access Token.
Optional extra query.
A querystring representation of this object.
Gets the subtitle profiles.
The transcoder support.
If only the selected track should be included.
The base URL.
The access token.
The of the profiles.
Gets the subtitle profiles.
The transcoder support.
If only the selected track should be included.
If all profiles are enabled.
The base URL.
The access token.
The of the profiles.
Gets the target video bit depth.
The codec.
The target video bit depth.
Gets the target audio bit depth.
The codec.
The target audio bit depth.
Gets the target video level.
The codec.
The target video level.
Gets the target reference frames.
The codec.
The target reference frames.
Gets the target audio channels.
The codec.
The target audio channels.
Gets the media stream count.
The type.
The limit.
The media stream count.
Delivery method to use during playback of a specific subtitle format.
Burn the subtitles in the video track.
Embed the subtitles in the file or stream.
Serve the subtitles as an external file.
Serve the subtitles as a separate HLS stream.
Drop the subtitle.
A class for subtitle profile information.
Gets or sets the format.
Gets or sets the delivery method.
Gets or sets the DIDL mode.
Gets or sets the language.
Gets or sets the container.
Checks if a language is supported.
The language to check for support.
true if supported.
A class for transcoding profile information.
Note for client developers: Conditions defined in has higher priority and can override values defined here.
Initializes a new instance of the class.
Initializes a new instance of the class copying the values from another instance.
Another instance of to be copied.
Gets or sets the container.
Gets or sets the DLNA profile type.
Gets or sets the video codec.
Gets or sets the audio codec.
Gets or sets the protocol.
Gets or sets a value indicating whether the content length should be estimated.
Gets or sets a value indicating whether M2TS mode is enabled.
Gets or sets the transcoding seek info mode.
Gets or sets a value indicating whether timestamps should be copied.
Gets or sets the encoding context.
Gets or sets a value indicating whether subtitles are allowed in the manifest.
Gets or sets the maximum audio channels.
Gets or sets the minimum amount of segments.
Gets or sets the segment length.
Gets or sets a value indicating whether breaking the video stream on non-keyframes is supported.
Gets or sets the profile conditions.
Gets or sets a value indicating whether variable bitrate encoding is supported.
Class DrawingUtils.
Resizes a set of dimensions.
The original size object.
A new fixed width, if desired.
A new fixed height, if desired.
A max fixed width, if desired.
A max fixed height, if desired.
A new size object.
Scale down to fill box.
Returns original size if both width and height are null or zero.
The original size object.
A new fixed width, if desired.
A new fixed height, if desired.
A new size object or size.
Gets the new width.
Height of the current.
Width of the current.
The new height.
The new width.
Gets the new height.
Height of the current.
Width of the current.
The new width.
System.Double.
Struct ImageDimensions.
Gets the height.
The height.
Gets the width.
The width.
Enum ImageOutputFormat.
BMP format.
GIF format.
JPG format.
PNG format.
WEBP format.
SVG format.
Extension class for the enum.
Returns the correct mime type for this .
This .
The is an invalid enumeration value.
The correct mime type for this .
Returns the correct extension for this .
This .
The is an invalid enumeration value.
The correct extension for this .
Enum ImageResolution.
MatchSource.
144p.
240p.
360p.
480p.
720p.
1080p.
1440p.
2160p.
This is strictly used as a data transfer object from the api layer.
This holds information about a BaseItem in a format that is convenient for the client.
Gets or sets the name.
The name.
Gets or sets the server identifier.
The server identifier.
Gets or sets the id.
The id.
Gets or sets the etag.
The etag.
Gets or sets the type of the source.
The type of the source.
Gets or sets the playlist item identifier.
The playlist item identifier.
Gets or sets the date created.
The date created.
Gets or sets the name of the sort.
The name of the sort.
Gets or sets the video3 D format.
The video3 D format.
Gets or sets the premiere date.
The premiere date.
Gets or sets the external urls.
The external urls.
Gets or sets the media versions.
The media versions.
Gets or sets the critic rating.
The critic rating.
Gets or sets the path.
The path.
Gets or sets the official rating.
The official rating.
Gets or sets the custom rating.
The custom rating.
Gets or sets the channel identifier.
The channel identifier.
Gets or sets the overview.
The overview.
Gets or sets the taglines.
The taglines.
Gets or sets the genres.
The genres.
Gets or sets the community rating.
The community rating.
Gets or sets the cumulative run time ticks.
The cumulative run time ticks.
Gets or sets the run time ticks.
The run time ticks.
Gets or sets the play access.
The play access.
Gets or sets the aspect ratio.
The aspect ratio.
Gets or sets the production year.
The production year.
Gets or sets a value indicating whether this instance is place holder.
null if [is place holder] contains no value, true if [is place holder]; otherwise, false.
Gets or sets the number.
The number.
Gets or sets the index number.
The index number.
Gets or sets the index number end.
The index number end.
Gets or sets the parent index number.
The parent index number.
Gets or sets the trailer urls.
The trailer urls.
Gets or sets the provider ids.
The provider ids.
Gets or sets a value indicating whether this instance is HD.
null if [is HD] contains no value, true if [is HD]; otherwise, false.
Gets or sets a value indicating whether this instance is folder.
true if this instance is folder; otherwise, false.
Gets or sets the parent id.
The parent id.
Gets or sets the type.
The type.
Gets or sets the people.
The people.
Gets or sets the studios.
The studios.
Gets or sets whether the item has a logo, this will hold the Id of the Parent that has one.
The parent logo item id.
Gets or sets whether the item has any backdrops, this will hold the Id of the Parent that has one.
The parent backdrop item id.
Gets or sets the parent backdrop image tags.
The parent backdrop image tags.
Gets or sets the local trailer count.
The local trailer count.
Gets or sets the user data for this item based on the user it's being requested for.
The user data.
Gets or sets the recursive item count.
The recursive item count.
Gets or sets the child count.
The child count.
Gets or sets the name of the series.
The name of the series.
Gets or sets the series id.
The series id.
Gets or sets the season identifier.
The season identifier.
Gets or sets the special feature count.
The special feature count.
Gets or sets the display preferences id.
The display preferences id.
Gets or sets the status.
The status.
Gets or sets the air time.
The air time.
Gets or sets the air days.
The air days.
Gets or sets the tags.
The tags.
Gets or sets the primary image aspect ratio, after image enhancements.
The primary image aspect ratio.
Gets or sets the artists.
The artists.
Gets or sets the artist items.
The artist items.
Gets or sets the album.
The album.
Gets or sets the type of the collection.
The type of the collection.
Gets or sets the display order.
The display order.
Gets or sets the album id.
The album id.
Gets or sets the album image tag.
The album image tag.
Gets or sets the series primary image tag.
The series primary image tag.
Gets or sets the album artist.
The album artist.
Gets or sets the album artists.
The album artists.
Gets or sets the name of the season.
The name of the season.
Gets or sets the media streams.
The media streams.
Gets or sets the type of the video.
The type of the video.
Gets or sets the part count.
The part count.
Gets or sets the image tags.
The image tags.
Gets or sets the backdrop image tags.
The backdrop image tags.
Gets or sets the screenshot image tags.
The screenshot image tags.
Gets or sets the parent logo image tag.
The parent logo image tag.
Gets or sets whether the item has fan art, this will hold the Id of the Parent that has one.
The parent art item id.
Gets or sets the parent art image tag.
The parent art image tag.
Gets or sets the series thumb image tag.
The series thumb image tag.
Gets or sets the blurhashes for the image tags.
Maps image type to dictionary mapping image tag to blurhash value.
The blurhashes.
Gets or sets the series studio.
The series studio.
Gets or sets the parent thumb item id.
The parent thumb item id.
Gets or sets the parent thumb image tag.
The parent thumb image tag.
Gets or sets the parent primary image item identifier.
The parent primary image item identifier.
Gets or sets the parent primary image tag.
The parent primary image tag.
Gets or sets the chapters.
The chapters.
Gets or sets the trickplay manifest.
The trickplay manifest.
Gets or sets the type of the location.
The type of the location.
Gets or sets the type of the iso.
The type of the iso.
Gets or sets the type of the media.
The type of the media.
Gets or sets the end date.
The end date.
Gets or sets the locked fields.
The locked fields.
Gets or sets the trailer count.
The trailer count.
Gets or sets the movie count.
The movie count.
Gets or sets the series count.
The series count.
Gets or sets the episode count.
The episode count.
Gets or sets the song count.
The song count.
Gets or sets the album count.
The album count.
Gets or sets the music video count.
The music video count.
Gets or sets a value indicating whether [enable internet providers].
true if [enable internet providers]; otherwise, false.
Gets or sets the series timer identifier.
The series timer identifier.
Gets or sets the program identifier.
The program identifier.
Gets or sets the channel primary image tag.
The channel primary image tag.
Gets or sets the start date of the recording, in UTC.
Gets or sets the completion percentage.
The completion percentage.
Gets or sets a value indicating whether this instance is repeat.
true if this instance is repeat; otherwise, false.
Gets or sets the episode title.
The episode title.
Gets or sets the type of the channel.
The type of the channel.
Gets or sets the audio.
The audio.
Gets or sets a value indicating whether this instance is movie.
true if this instance is movie; otherwise, false.
Gets or sets a value indicating whether this instance is sports.
true if this instance is sports; otherwise, false.
Gets or sets a value indicating whether this instance is series.
true if this instance is series; otherwise, false.
Gets or sets a value indicating whether this instance is live.
true if this instance is live; otherwise, false.
Gets or sets a value indicating whether this instance is news.
true if this instance is news; otherwise, false.
Gets or sets a value indicating whether this instance is kids.
true if this instance is kids; otherwise, false.
Gets or sets a value indicating whether this instance is premiere.
true if this instance is premiere; otherwise, false.
Gets or sets the timer identifier.
The timer identifier.
Gets or sets the gain required for audio normalization.
The gain required for audio normalization.
Gets or sets the current program.
The current program.
This is used by the api to get information about a Person within a BaseItem.
Gets or sets the name.
The name.
Gets or sets the identifier.
The identifier.
Gets or sets the role.
The role.
Gets or sets the type.
The type.
Gets or sets the primary image tag.
The primary image tag.
Gets or sets the primary image blurhash.
The primary image blurhash.
Gets a value indicating whether this instance has primary image.
true if this instance has primary image; otherwise, false.
Client capabilities dto.
Gets or sets the list of playable media types.
Gets or sets the list of supported commands.
Gets or sets a value indicating whether session supports media control.
Gets or sets a value indicating whether session supports a persistent identifier.
Gets or sets the device profile.
Gets or sets the app store url.
Gets or sets the icon url.
Convert the dto to the full model.
The converted model.
A DTO representing device information.
Initializes a new instance of the class.
Gets or sets the name.
The name.
Gets or sets the custom name.
The custom name.
Gets or sets the access token.
The access token.
Gets or sets the identifier.
The identifier.
Gets or sets the last name of the user.
The last name of the user.
Gets or sets the name of the application.
The name of the application.
Gets or sets the application version.
The application version.
Gets or sets the last user identifier.
The last user identifier.
Gets or sets the date last modified.
The date last modified.
Gets or sets the capabilities.
The capabilities.
Gets or sets the icon URL.
The icon URL.
Defines the display preferences for any item that supports them (usually Folders).
Initializes a new instance of the class.
Gets or sets the user id.
The user id.
Gets or sets the type of the view.
The type of the view.
Gets or sets the sort by.
The sort by.
Gets or sets the index by.
The index by.
Gets or sets a value indicating whether [remember indexing].
true if [remember indexing]; otherwise, false.
Gets or sets the height of the primary image.
The height of the primary image.
Gets or sets the width of the primary image.
The width of the primary image.
Gets or sets the custom prefs.
The custom prefs.
Gets or sets the scroll direction.
The scroll direction.
Gets or sets a value indicating whether to show backdrops on this item.
true if showing backdrops; otherwise, false.
Gets or sets a value indicating whether [remember sorting].
true if [remember sorting]; otherwise, false.
Gets or sets the sort order.
The sort order.
Gets or sets a value indicating whether [show sidebar].
true if [show sidebar]; otherwise, false.
Gets or sets the client.
Interface IItemDto.
Gets or sets the primary image aspect ratio.
The primary image aspect ratio.
Class ImageInfo.
Gets or sets the type of the image.
The type of the image.
Gets or sets the index of the image.
The index of the image.
Gets or sets the image tag.
Gets or sets the path.
The path.
Gets or sets the blurhash.
The blurhash.
Gets or sets the height.
The height.
Gets or sets the width.
The width.
Gets or sets the size.
The size.
Class LibrarySummary.
Gets or sets the movie count.
The movie count.
Gets or sets the series count.
The series count.
Gets or sets the episode count.
The episode count.
Gets or sets the artist count.
The artist count.
Gets or sets the program count.
The program count.
Gets or sets the trailer count.
The trailer count.
Gets or sets the song count.
The song count.
Gets or sets the album count.
The album count.
Gets or sets the music video count.
The music video count.
Gets or sets the box set count.
The box set count.
Gets or sets the book count.
The book count.
Gets or sets the item count.
The item count.
Adds all counts.
The total of the counts.
Gets or sets a value indicating whether the media is remote.
Differentiate internet url vs local network.
A class representing metadata editor information.
Initializes a new instance of the class.
Gets or sets the parental rating options.
Gets or sets the countries.
Gets or sets the cultures.
Gets or sets the external id infos.
Gets or sets the content type.
Gets or sets the content type options.
Gets or sets the name.
The name.
Gets or sets the identifier.
The identifier.
Gets or sets the name.
The name.
Gets or sets the value.
The value.
DTO for playlists.
Gets or sets a value indicating whether the playlist is publicly readable.
Gets or sets the share permissions.
Gets or sets the item ids.
Session info DTO.
Gets or sets the play state.
The play state.
Gets or sets the additional users.
The additional users.
Gets or sets the client capabilities.
The client capabilities.
Gets or sets the remote end point.
The remote end point.
Gets or sets the playable media types.
The playable media types.
Gets or sets the id.
The id.
Gets or sets the user id.
The user id.
Gets or sets the username.
The username.
Gets or sets the type of the client.
The type of the client.
Gets or sets the last activity date.
The last activity date.
Gets or sets the last playback check in.
The last playback check in.
Gets or sets the last paused date.
The last paused date.
Gets or sets the name of the device.
The name of the device.
Gets or sets the type of the device.
The type of the device.
Gets or sets the now playing item.
The now playing item.
Gets or sets the now viewing item.
The now viewing item.
Gets or sets the device id.
The device id.
Gets or sets the application version.
The application version.
Gets or sets the transcoding info.
The transcoding info.
Gets or sets a value indicating whether this session is active.
true if this session is active; otherwise, false.
Gets or sets a value indicating whether the session supports media control.
true if this session supports media control; otherwise, false.
Gets or sets a value indicating whether the session supports remote control.
true if this session supports remote control; otherwise, false.
Gets or sets the now playing queue.
The now playing queue.
Gets or sets the now playing queue full items.
The now playing queue full items.
Gets or sets a value indicating whether the session has a custom device name.
true if this session has a custom device name; otherwise, false.
Gets or sets the playlist item id.
The playlist item id.
Gets or sets the server id.
The server id.
Gets or sets the user primary image tag.
The user primary image tag.
Gets or sets the supported commands.
The supported commands.
The trickplay api model.
Initializes a new instance of the class.
The trickplay info.
Gets the width of an individual thumbnail.
Gets the height of an individual thumbnail.
Gets the amount of thumbnails per row.
Gets the amount of thumbnails per column.
Gets the total amount of non-black thumbnails.
Gets the interval in milliseconds between each trickplay thumbnail.
Gets the peak bandwidth usage in bits per second.
This is used by the api to get information about a item user data.
Gets or sets the rating.
The rating.
Gets or sets the played percentage.
The played percentage.
Gets or sets the unplayed item count.
The unplayed item count.
Gets or sets the playback position ticks.
The playback position ticks.
Gets or sets the play count.
The play count.
Gets or sets a value indicating whether this instance is favorite.
true if this instance is favorite; otherwise, false.
Gets or sets a value indicating whether this is likes.
null if [likes] contains no value, true if [likes]; otherwise, false.
Gets or sets the last played date.
The last played date.
Gets or sets a value indicating whether this is played.
true if played; otherwise, false.
Gets or sets the key.
The key.
Gets or sets the item identifier.
The item identifier.
Class UserDto.
Initializes a new instance of the class.
Gets or sets the name.
The name.
Gets or sets the server identifier.
The server identifier.
Gets or sets the name of the server.
This is not used by the server and is for client-side usage only.
The name of the server.
Gets or sets the id.
The id.
Gets or sets the primary image tag.
The primary image tag.
Gets or sets a value indicating whether this instance has password.
true if this instance has password; otherwise, false.
Gets or sets a value indicating whether this instance has configured password.
true if this instance has configured password; otherwise, false.
Gets or sets a value indicating whether this instance has configured easy password.
true if this instance has configured easy password; otherwise, false.
Gets or sets whether async login is enabled or not.
Gets or sets the last login date.
The last login date.
Gets or sets the last activity date.
The last activity date.
Gets or sets the configuration.
The configuration.
Gets or sets the policy.
The policy.
Gets or sets the primary image aspect ratio.
The primary image aspect ratio.
Class UserItemDataDto.
Gets or sets the rating.
The rating.
Gets or sets the played percentage.
The played percentage.
Gets or sets the unplayed item count.
The unplayed item count.
Gets or sets the playback position ticks.
The playback position ticks.
Gets or sets the play count.
The play count.
Gets or sets a value indicating whether this instance is favorite.
true if this instance is favorite; otherwise, false.
Gets or sets a value indicating whether this is likes.
null if [likes] contains no value, true if [likes]; otherwise, false.
Gets or sets the last played date.
The last played date.
Gets or sets a value indicating whether this is played.
true if played; otherwise, false.
Gets or sets the key.
The key.
Gets or sets the item identifier.
The item identifier.
Class ChapterInfo.
Gets or sets the start position ticks.
The start position ticks.
Gets or sets the name.
The name.
Gets or sets the image path.
The image path.
The collection type options.
Movies.
TV Shows.
Music.
Music Videos.
Home Videos (and Photos).
Box Sets.
Books.
Mixed Movies and TV Shows.
Enum containing deinterlace methods.
YADIF.
BWDIF.
An enum representing an algorithm to downmix surround sound to stereo.
No special algorithm.
Algorithm by Dave_750.
Sourced from https://superuser.com/questions/852400/properly-downmix-5-1-to-stereo-using-ffmpeg/1410620#1410620.
Nightmode Dialogue algorithm.
Sourced from https://superuser.com/questions/852400/properly-downmix-5-1-to-stereo-using-ffmpeg/1410620#1410620.
RFC7845 Section 5.1.1.5 defined algorithm.
AC-4 standard algorithm with its default gain values.
Defined in ETSI TS 103 190 Section 6.2.17.
Enum containing encoder presets.
Auto preset.
Placebo preset.
Veryslow preset.
Slower preset.
Slow preset.
Medium preset.
Fast preset.
Faster preset.
Veryfast preset.
Superfast preset.
Ultrafast preset.
Enum containing hardware acceleration types.
Software acceleration.
AMD AMF.
Intel Quick Sync Video.
NVIDIA NVENC.
Video4Linux2 V4L2M2M.
Video Acceleration API (VAAPI).
Video ToolBox.
Rockchip Media Process Platform (RKMPP).
Since BaseItem and DTOBaseItem both have ProviderIds, this interface helps avoid code repetition by using extension methods.
Gets or sets the provider ids.
The provider ids.
Interface for access to shares.
Gets or sets the shares.
Enum ImageType.
The primary.
The art.
The backdrop.
The banner.
The logo.
The thumb.
The disc.
The box.
The screenshot.
This enum value is obsolete.
XmlSerializer does not serialize/deserialize objects that are marked as [Obsolete].
The menu.
The chapter image.
The box rear.
The user profile image.
Enum IsoType.
The DVD.
The blu ray.
Class LibraryUpdateInfo.
Initializes a new instance of the class.
Gets or sets the folders added to.
The folders added to.
Gets or sets the folders removed from.
The folders removed from.
Gets or sets the items added.
The items added.
Gets or sets the items removed.
The items removed.
Gets or sets the items updated.
The items updated.
Enum LocationType.
The file system.
The remote.
The virtual.
The offline.
Class MediaAttachment.
Gets or sets the codec.
The codec.
Gets or sets the codec tag.
The codec tag.
Gets or sets the comment.
The comment.
Gets or sets the index.
The index.
Gets or sets the filename.
The filename.
Gets or sets the MIME type.
The MIME type.
Gets or sets the delivery URL.
The delivery URL.
Class MediaStream.
Special ISO 639-2 language codes that should not be displayed in the UI.
Gets or sets the codec.
The codec.
Gets or sets the codec tag.
The codec tag.
Gets or sets the language.
The language.
Gets or sets the color range.
The color range.
Gets or sets the color space.
The color space.
Gets or sets the color transfer.
The color transfer.
Gets or sets the color primaries.
The color primaries.
Gets or sets the Dolby Vision version major.
The Dolby Vision version major.
Gets or sets the Dolby Vision version minor.
The Dolby Vision version minor.
Gets or sets the Dolby Vision profile.
The Dolby Vision profile.
Gets or sets the Dolby Vision level.
The Dolby Vision level.
Gets or sets the Dolby Vision rpu present flag.
The Dolby Vision rpu present flag.
Gets or sets the Dolby Vision el present flag.
The Dolby Vision el present flag.
Gets or sets the Dolby Vision bl present flag.
The Dolby Vision bl present flag.
Gets or sets the Dolby Vision bl signal compatibility id.
The Dolby Vision bl signal compatibility id.
Gets or sets the Rotation in degrees.
The video rotation.
Gets or sets the comment.
The comment.
Gets or sets the time base.
The time base.
Gets or sets the codec time base.
The codec time base.
Gets or sets the title.
The title.
Gets or sets a value indicating whether the HDR10+ present flag.
The HDR10+ present flag.
Gets the video range.
The video range.
Gets the video range type.
The video range type.
Gets the video dovi title.
The video dovi title.
Gets the audio spatial format.
The audio spatial format.
Gets or sets the localized text for undefined language.
The localized text for undefined language.
Gets or sets the localized text for default stream indicator.
The localized text for default stream indicator.
Gets or sets the localized text for forced stream indicator.
The localized text for forced stream indicator.
Gets or sets the localized text for external stream indicator.
The localized text for external stream indicator.
Gets or sets the localized text for hearing impaired indicator.
The localized text for hearing impaired indicator.
Gets or sets the localized language name.
The localized language name.
Gets the display title for the media stream.
The display title.
Gets or sets the NAL length size.
The NAL length size.
Gets or sets a value indicating whether this instance is interlaced.
true if this instance is interlaced; otherwise, false.
Gets or sets a value indicating whether this instance is AVC.
true if this instance is AVC; otherwise, false.
Gets or sets the channel layout.
The channel layout.
Gets or sets the bit rate.
The bit rate.
Gets or sets the bit depth.
The bit depth.
Gets or sets the reference frames.
The reference frames.
Gets or sets the length of the packet.
The length of the packet.
Gets or sets the channels.
The channels.
Gets or sets the sample rate.
The sample rate.
Gets or sets a value indicating whether this instance is default.
true if this instance is default; otherwise, false.
Gets or sets a value indicating whether this instance is forced.
true if this instance is forced; otherwise, false.
Gets or sets a value indicating whether this instance is for the hearing impaired.
true if this instance is for the hearing impaired; otherwise, false.
Gets or sets the height.
The height.
Gets or sets the width.
The width.
Gets or sets the average frame rate.
The average frame rate.
Gets or sets the real frame rate.
The real frame rate.
Gets the framerate used as reference.
Prefer AverageFrameRate, if that is null or an unrealistic value
then fallback to RealFrameRate.
The reference frame rate.
Gets or sets the profile.
The profile.
Gets or sets the type.
The type.
Gets or sets the aspect ratio.
The aspect ratio.
Gets or sets the index.
The index.
Gets or sets the score.
The score.
Gets or sets a value indicating whether this instance is external.
true if this instance is external; otherwise, false.
Gets or sets the method.
The method.
Gets or sets the delivery URL.
The delivery URL.
Gets or sets a value indicating whether this instance is external URL.
null if [is external URL] contains no value, true if [is external URL]; otherwise, false.
Gets a value indicating whether this instance is a text subtitle stream.
true if this instance is a text subtitle stream; otherwise, false.
Gets a value indicating whether this instance is a PGS subtitle stream.
true if this instance is a PGS subtitle stream; otherwise, false.
Gets a value indicating whether this is a subtitle steam that is extractable by ffmpeg.
All text-based and pgs subtitles can be extracted.
true if this is a extractable subtitle steam otherwise, false.
Gets or sets a value indicating whether [supports external stream].
true if [supports external stream]; otherwise, false.
Gets or sets the filename.
The filename.
Gets or sets the pixel format.
The pixel format.
Gets or sets the level.
The level.
Gets or sets whether this instance is anamorphic.
true if this instance is anamorphic; otherwise, false.
Determines whether the specified format is a text-based subtitle format.
The subtitle format/codec to check.
true if the format is text-based; otherwise, false.
Determines whether the specified format is a PGS (Presentation Graphic Stream) subtitle format.
The subtitle format/codec to check.
true if the format is PGS; otherwise, false.
Determines whether this subtitle stream can be converted to the specified codec.
The target codec to convert to.
true if the subtitle stream can be converted to the specified codec; otherwise, false.
Gets the video color range information based on codec tags, Dolby Vision properties, and color transfer characteristics.
A tuple containing the video range (SDR/HDR) and the specific video range type.
Gets the resolution text based on width and height.
The resolution text (e.g., "1080p", "4K") or null if width/height are not available.
Enum MediaStreamType.
The audio.
The video.
The subtitle.
The embedded image.
The data.
The lyric.
Enum MetadataFields.
The cast.
The genres.
The production locations.
The studios.
The tags.
The name.
The overview.
The runtime.
The official rating.
Enum MetadataProviders.
This metadata provider is for users and/or plugins to override the
default merging behaviour.
The IMDb provider.
The TMDb provider.
The TVDb provider.
The tvcom provider.
TMDb collection provider.
The MusicBrainz album provider.
The MusicBrainz album artist provider.
The MusicBrainz artist provider.
The MusicBrainz release group provider.
The Zap2It provider.
The TvRage provider.
The AudioDb artist provider.
The AudioDb collection provider.
The MusicBrainz track provider.
The TvMaze provider.
The MusicBrainz recording provider.
Class ParentalRating.
Initializes a new instance of the class.
The name.
The score.
Gets or sets the name.
The name.
Gets or sets the value.
The value.
Deprecated.
Gets or sets the rating score.
The rating score.
A class representing an parental rating entry.
Gets or sets the rating strings.
Gets or sets the score.
A class representing an parental rating score.
Initializes a new instance of the class.
The score.
The sub score.
Gets or sets the score.
Gets or sets the sub score.
A class representing a parental rating system.
Gets or sets the country code.
Gets or sets a value indicating whether sub scores are supported.
Gets or sets the ratings.
Types of persons.
A person whose profession is acting on the stage, in films, or on television.
A person who supervises the actors and other staff in a film, play, or similar production.
A person who writes music, especially as a professional occupation.
A writer of a book, article, or document. Can also be used as a generic term for music writer if there is a lack of specificity.
A well-known actor or other performer who appears in a work in which they do not have a regular role.
A person responsible for the financial and managerial aspects of the making of a film or broadcast or for staging a play, opera, etc.
A person who directs the performance of an orchestra or choir.
A person who writes the words to a song or musical.
A person who adapts a musical composition for performance.
An audio engineer who performed a general engineering role.
An engineer responsible for using a mixing console to mix a recorded track into a single piece of music suitable for release.
A person who remixed a recording by taking one or more other tracks, substantially altering them and mixing them together with other material.
Class to hold data on user permissions for playlists.
Initializes a new instance of the class.
The user id.
Edit permission.
Gets or sets the user id.
Gets or sets a value indicating whether the user has edit permissions.
Class ProviderIdsExtensions.
Case-insensitive dictionary of string representation.
Checks if this instance has an id for the given provider.
The instance.
The of the provider name.
true if a provider id with the given name was found; otherwise false.
Checks if this instance has an id for the given provider.
The instance.
The provider.
true if a provider id with the given name was found; otherwise false.
Gets a provider id.
The instance.
The name.
The provider id.
true if a provider id with the given name was found; otherwise false.
Gets a provider id.
The instance.
The provider.
The provider id.
true if a provider id with the given name was found; otherwise false.
Gets a provider id.
The instance.
The name.
System.String.
Gets a provider id.
The instance.
The provider.
System.String.
Sets a provider id.
The instance.
The name, this should not contain a '=' character.
The value.
Due to how deserialization from the database works the name cannot contain '='.
true if the provider id got set successfully; otherwise, false.
Sets a provider id.
The instance.
The provider.
The value.
true if the provider id got set successfully; otherwise, false.
Sets a provider id.
The instance.
The name, this should not contain a '=' character.
The value.
Due to how deserialization from the database works the name cannot contain '='.
Sets a provider id.
The instance.
The provider.
The value.
Removes a provider id.
The instance.
The name.
Removes a provider id.
The instance.
The provider.
The status of a series.
The continuing status. This indicates that a series is currently releasing.
The ended status. This indicates that a series has completed and is no longer being released.
The unreleased status. This indicates that a series has not been released yet.
Enum containing tonemapping algorithms.
None.
Clip.
Linear.
Gamma.
Reinhard.
Hable.
Mobius.
BT2390.
Enum containing tonemapping modes.
Auto.
Max.
RGB.
Lum.
ITP.
Enum containing tonemapping ranges.
Auto.
TV.
PC.
Enum UserDataSaveReason.
The playback start.
The playback progress.
The playback finished.
The toggle played.
The update user rating.
The import.
API call updated item user data.
Enum VideoType.
The video file.
The iso.
The DVD.
The blu ray.
Used to hold information about a user's list of configured virtual folders.
Initializes a new instance of the class.
Gets or sets the name.
The name.
Gets or sets the locations.
The locations.
Gets or sets the type of the collection.
The type of the collection.
Gets or sets the item identifier.
The item identifier.
Gets or sets the primary image item identifier.
The primary image item identifier.
Defines the class.
Compares two containers, returning true if an item in exists
in .
The comma-delimited string being searched.
If the parameter begins with the - character, the operation is reversed.
If the parameter is empty or null, all containers in will be accepted.
The comma-delimited string being matched.
The result of the operation.
Compares two containers, returning true if an item in exists
in .
The comma-delimited string being searched.
If the parameter begins with the - character, the operation is reversed.
If the parameter is empty or null, all containers in will be accepted.
The comma-delimited string being matched.
The result of the operation.
Compares two containers, returning if an item in
does not exist in .
The comma-delimited string being searched.
If the parameter is empty or null, all containers in will be accepted.
The boolean result to return if a match is not found.
The comma-delimited string being matched.
The result of the operation.
Compares two containers, returning if an item in
does not exist in .
The comma-delimited string being searched.
If the parameter is empty or null, all containers in will be accepted.
The boolean result to return if a match is not found.
The comma-delimited string being matched.
The result of the operation.
Compares two containers, returning if an item in
does not exist in .
The profile containers being matched searched.
If the parameter is empty or null, all containers in will be accepted.
The boolean result to return if a match is not found.
The comma-delimited string being matched.
The result of the operation.
Splits and input string.
The input string.
The result of the operation.
Extension methods for .
Orders by requested language in descending order, prioritizing "en" over other non-matches.
The remote image infos.
The requested language for the images.
The ordered remote image infos.
Extensions for .
Get the custom tag delimiters.
This LibraryOptions.
CustomTagDelimiters in char[].
Helper methods for manipulating strings.
Returns the string with the first character as uppercase.
The input string.
The string with the first character as uppercase.
Class CountryInfo.
Gets or sets the name.
The name.
Gets or sets the display name.
The display name.
Gets or sets the name of the two letter ISO region.
The name of the two letter ISO region.
Gets or sets the name of the three letter ISO region.
The name of the three letter ISO region.
Class CultureDto.
Gets the name.
The name.
Gets the display name.
The display name.
Gets the name of the two letter ISO language.
The name of the two letter ISO language.
Gets the name of the three letter ISO language.
The name of the three letter ISO language.
Interface ILocalizationManager.
Gets the cultures.
.
Gets the countries.
.
Gets the parental ratings.
.
Gets the rating level.
The rating.
The optional two letter ISO language string.
or null.
Gets the localized string.
The phrase.
The culture.
.
Gets the localized string.
The phrase.
System.String.
Gets the localization options.
.
Returns the correct for the given language.
The language.
The correct for the given language.
Returns the language in ISO 639-2/T when the input is ISO 639-2/B.
The language in ISO 639-2/B.
The language in ISO 639-2/T.
Whether the language could be converted.
Helper class to create async s.
Gets the default for reading files async.
Gets the default for writing files async.
Creates, or truncates and overwrites, a file in the specified path.
The path and name of the file to create.
A that provides read/write access to the file specified in path.
Opens an existing file for reading.
The file to be opened for reading.
A read-only on the specified path.
Opens an existing file for writing.
The file to be opened for writing.
An unshared object on the specified path with Write access.
Class FileSystemEntryInfo.
Initializes a new instance of the class.
The filename.
The file path.
The file type.
Gets the name.
The name.
Gets the path.
The path.
Gets the type.
The type.
Enum FileSystemEntryType.
The file.
The directory.
The network computer.
The network share.
Gets or sets a value indicating whether this is exists.
true if exists; otherwise, false.
Gets or sets the full name.
The full name.
Gets or sets the name.
The name.
Gets or sets the extension.
The extension.
Gets or sets the length.
The length.
Gets or sets the last write time UTC.
The last write time UTC.
Gets or sets the creation time UTC.
The creation time UTC.
Gets or sets a value indicating whether this instance is directory.
true if this instance is directory; otherwise, false.
Interface IFileSystem.
Determines whether the specified filename is shortcut.
The filename.
true if the specified filename is shortcut; otherwise, false.
Resolves the shortcut.
The filename.
System.String.
Creates the shortcut.
The shortcut path.
The target.
Moves a directory to a new location.
Source directory.
Destination directory.
Returns a object for the specified file or directory path.
A path to a file or directory.
A object.
If the specified path points to a directory, the returned object's
property will be set to true and all other properties will reflect the properties of the directory.
Returns a object for the specified file path.
A path to a file.
A object.
If the specified path points to a directory, the returned object's
property and the property will both be set to false.
For automatic handling of files and directories, use .
Returns a object for the specified directory path.
A path to a directory.
A object.
If the specified path points to a file, the returned object's
property will be set to true and the property will be set to false.
For automatic handling of files and directories, use .
Gets the valid filename.
The filename.
System.String.
Gets the creation time UTC.
The information.
DateTime.
Gets the creation time UTC.
The path.
DateTime.
Gets the last write time UTC.
The information.
DateTime.
Gets the last write time UTC.
The path.
DateTime.
Swaps the files.
The file1.
The file2.
Determines whether [contains sub path] [the specified parent path].
The parent path.
The path.
true if [contains sub path] [the specified parent path]; otherwise, false.
Gets the file name without extension.
The information.
System.String.
Determines whether [is path file] [the specified path].
The path.
true if [is path file] [the specified path]; otherwise, false.
Deletes the file.
The path.
Gets the directories.
The path.
If set to true also searches in subdirectories.
All found directories.
Gets the files.
The path in which to search.
If set to true also searches in subdirectories.
All found files.
Gets the files.
The path in which to search.
The search string to match against the names of files. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
If set to true also searches in subdirectories.
All found files.
Gets the files.
The path in which to search.
The file extensions to search for.
Enable case-sensitive check for extensions.
If set to true also searches in subdirectories.
All found files.
Gets the files.
The path in which to search.
The search string to match against the names of files. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
The file extensions to search for.
Enable case-sensitive check for extensions.
If set to true also searches in subdirectories.
All found files.
Gets the file system entries.
The path.
if set to true [recursive].
IEnumerable<FileSystemMetadata>.
Gets the directory paths.
The path.
if set to true [recursive].
IEnumerable<System.String>.
Gets the file paths.
The path.
if set to true [recursive].
IEnumerable<System.String>.
Gets the file system entry paths.
The path.
if set to true [recursive].
IEnumerable<System.String>.
Determines whether the directory exists.
The path.
Whether the path exists.
Determines whether the file exists.
The path.
Whether the path exists.
Class IODefaults.
The default copy to buffer size.
The default file stream buffer size.
The default buffer size.
Gets the extension.
The extension.
Resolves the specified shortcut path.
The shortcut path.
System.String.
Creates the specified shortcut path.
The shortcut path.
The target path.
Gets or sets the user.
The user.
Gets or sets a value indicating whether [include external content].
true if [include external content]; otherwise, false.
Gets or sets a value indicating whether [include hidden].
true if [include hidden]; otherwise, false.
Gets or sets the Id of the recording.
Gets or sets the server identifier.
The server identifier.
Gets or sets the external identifier.
The external identifier.
Gets or sets the channel id of the recording.
Gets or sets the external channel identifier.
The external channel identifier.
Gets or sets the channel name of the recording.
Gets or sets the program identifier.
The program identifier.
Gets or sets the external program identifier.
The external program identifier.
Gets or sets the name of the recording.
Gets or sets the description of the recording.
Gets or sets the start date of the recording, in UTC.
Gets or sets the end date of the recording, in UTC.
Gets or sets the name of the service.
The name of the service.
Gets or sets the priority.
The priority.
Gets or sets the pre padding seconds.
The pre padding seconds.
Gets or sets the post padding seconds.
The post padding seconds.
Gets or sets a value indicating whether this instance is pre padding required.
true if this instance is pre padding required; otherwise, false.
Gets or sets the Id of the Parent that has a backdrop if the item does not have one.
The parent backdrop item id.
Gets or sets the parent backdrop image tags.
The parent backdrop image tags.
Gets or sets a value indicating whether this instance is post padding required.
true if this instance is post padding required; otherwise, false.
Channel mapping options dto.
Gets or sets list of tuner channels.
Gets or sets list of provider channels.
Gets or sets list of mappings.
Gets or sets provider name.
Enum ChannelType.
The TV.
The radio.
Gets or sets the start date.
The start date.
Gets or sets the end date.
The end date.
Class ChannelQuery.
Gets or sets the type of the channel.
The type of the channel.
Gets or sets a value indicating whether this instance is favorite.
null if [is favorite] contains no value, true if [is favorite]; otherwise, false.
Gets or sets a value indicating whether this instance is liked.
null if [is liked] contains no value, true if [is liked]; otherwise, false.
Gets or sets a value indicating whether this instance is disliked.
null if [is disliked] contains no value, true if [is disliked]; otherwise, false.
Gets or sets a value indicating whether [enable favorite sorting].
true if [enable favorite sorting]; otherwise, false.
Gets or sets the user identifier.
The user identifier.
Gets or sets the start index. Used for paging.
The start index.
Gets or sets the maximum number of items to return.
The limit.
Gets or sets a value indicating whether [add current program].
true if [add current program]; otherwise, false.
Gets or sets a value whether to return news or not.
If set to null, all programs will be returned.
Gets or sets a value whether to return movies or not.
If set to null, all programs will be returned.
Gets or sets a value indicating whether this instance is kids.
null if [is kids] contains no value, true if [is kids]; otherwise, false.
Gets or sets a value indicating whether this instance is sports.
null if [is sports] contains no value, true if [is sports]; otherwise, false.
Gets or sets the sort order to return results with.
The sort order.
Gets or sets the services.
The services.
Gets or sets a value indicating whether this instance is enabled.
true if this instance is enabled; otherwise, false.
Gets or sets the enabled users.
The enabled users.
Class ServiceInfo.
Gets or sets the name.
The name.
Gets or sets the home page URL.
The home page URL.
Gets or sets the status.
The status.
Gets or sets the status message.
The status message.
Gets or sets the version.
The version.
Gets or sets a value indicating whether this instance has update available.
true if this instance has update available; otherwise, false.
Gets or sets a value indicating whether this instance is visible.
true if this instance is visible; otherwise, false.
Class RecordingQuery.
Gets or sets the channel identifier.
The channel identifier.
Gets or sets the user identifier.
The user identifier.
Gets or sets the identifier.
The identifier.
Gets or sets the start index. Use for paging.
The start index.
Gets or sets the maximum number of items to return.
The limit.
Gets or sets the status.
The status.
Gets or sets a value indicating whether this instance is in progress.
null if [is in progress] contains no value, true if [is in progress]; otherwise, false.
Gets or sets the series timer identifier.
The series timer identifier.
Gets or sets the fields to return within the items, in addition to basic information.
The fields.
Class SeriesTimerInfoDto.
Gets or sets a value indicating whether [record any time].
true if [record any time]; otherwise, false.
Gets or sets a value indicating whether [record any channel].
true if [record any channel]; otherwise, false.
Gets or sets a value indicating whether [record new only].
true if [record new only]; otherwise, false.
Gets or sets the days.
The days.
Gets or sets the day pattern.
The day pattern.
Gets or sets the image tags.
The image tags.
Gets or sets the parent thumb item id.
The parent thumb item id.
Gets or sets the parent thumb image tag.
The parent thumb image tag.
Gets or sets the parent primary image item identifier.
The parent primary image item identifier.
Gets or sets the parent primary image tag.
The parent primary image tag.
Gets or sets the sort by - SortName, Priority.
The sort by.
Gets or sets the sort order.
The sort order.
Gets or sets the status.
The status.
Gets or sets the series timer identifier.
The series timer identifier.
Gets or sets the external series timer identifier.
The external series timer identifier.
Gets or sets the run time ticks.
The run time ticks.
Gets or sets the program information.
The program information.
Gets or sets the channel identifier.
The channel identifier.
Gets or sets the series timer identifier.
The series timer identifier.
LyricResponse model.
Gets or sets Metadata for the lyrics.
Gets or sets a collection of individual lyric lines.
The information for a raw lyrics file before parsing.
Initializes a new instance of the class.
The name.
The content, must not be empty.
Gets or sets the name of the lyrics file. This must include the file extension.
Gets or sets the contents of the file.
Lyric model.
Initializes a new instance of the class.
The lyric text.
The lyric start time in ticks.
The time-aligned cues for the song's lyrics.
Gets the text of this lyric line.
Gets the start time in ticks.
Gets the time-aligned cues for the song's lyrics.
LyricLineCue model, holds information about the timing of words within a LyricLine.
Initializes a new instance of the class.
The start character index of the cue.
The end character index of the cue.
The start of the timestamp the lyric is synced to in ticks.
The end of the timestamp the lyric is synced to in ticks.
Gets the start character index of the cue.
Gets the end character index of the cue.
Gets the timestamp the lyric is synced to in ticks.
Gets the end timestamp the lyric is synced to in ticks.
LyricMetadata model.
Gets or sets the song artist.
Gets or sets the album this song is on.
Gets or sets the title of the song.
Gets or sets the author of the lyric data.
Gets or sets the length of the song in ticks.
Gets or sets who the LRC file was created by.
Gets or sets the lyric offset compared to audio in ticks.
Gets or sets the software used to create the LRC file.
Gets or sets the version of the creator used.
Gets or sets a value indicating whether this lyric is synced.
LyricResponse model.
Gets or sets the lyric stream.
Gets or sets the lyric format.
Lyric search request.
Gets or sets the media path.
Gets or sets the album artist names.
Gets or sets the artist names.
Gets or sets the album name.
Gets or sets the song name.
Gets or sets the track duration in ticks.
Gets or sets a value indicating whether to search all providers.
Gets or sets the list of disabled lyric fetcher names.
Gets or sets the order of lyric fetchers.
Gets or sets a value indicating whether this request is automated.
The remote lyric info dto.
Gets or sets the id for the lyric.
Gets the provider name.
Gets the lyrics.
Upload lyric dto.
Gets or sets the lyrics file.
How is the audio index determined.
The default index when no preference is specified.
The index is calculated whether the track is marked as default or not.
The index is calculated whether the track is in preferred language or not.
The index is specified by the user.
Represents the result of BDInfo output.
Gets or sets the media streams.
The media streams.
Gets or sets the run time ticks.
The run time ticks.
Gets or sets the files.
The files.
Gets or sets the playlist name.
The playlist name.
Gets or sets the chapters.
The chapters.
Interface IBlurayExaminer.
Gets the disc info.
The path.
BlurayDiscInfo.
Gets or sets the album.
The album.
Gets or sets the artists.
The artists.
Gets or sets the album artists.
The album artists.
Gets or sets the studios.
The studios.
Gets or sets the official rating.
The official rating.
Gets or sets the official rating description.
The official rating description.
Gets or sets the overview.
The overview.
Class PlaybackInfoResponse.
Initializes a new instance of the class.
Gets or sets the media sources.
The media sources.
Gets or sets the play session identifier.
The play session identifier.
Gets or sets the error code.
The error code.
Api model for MediaSegment's.
Gets or sets the id of the media segment.
Gets or sets the id of the associated item.
Gets or sets the type of content this segment defines.
Gets or sets the start of the segment.
Gets or sets the end of the segment.
Model containing the arguments for enumerating the requested media item.
Gets the Id to the BaseItem the segments should be extracted from.
Gets existing media segments generated on an earlier scan by this provider.
Base network object class.
Initializes a new instance of the class.
The .
The .
The interface name.
Initializes a new instance of the class.
The .
The .
Gets or sets the object's IP address.
Gets or sets the object's IP address.
Gets or sets the interface index.
Gets or sets a value indicating whether the network supports multicast.
Gets or sets the interface name.
Gets the AddressFamily of the object.
Implemented by components that can create specific socket configurations.
Creates a new unicast socket using the specified local port number.
The local port to bind to.
A new unicast socket using the specified local port number.
Class MimeTypes.
For more information on MIME types:
- http://en.wikipedia.org/wiki/Internet_media_type
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
- http://www.iana.org/assignments/media-types/media-types.xhtml
Any extension in this list is considered a video file.
Used for extensions not in or to override them.
Gets the type of the MIME.
The filename to find the MIME type of.
The default value to return if no fitting MIME type is found.
The correct MIME type for the given filename, or if it wasn't found.
Class holding information for a published server URI override.
Initializes a new instance of the class.
The .
The override.
A value indicating whether the override is for internal requests.
A value indicating whether the override is for external requests.
Gets or sets the object's IP address.
Gets or sets the override URI.
Gets or sets a value indicating whether the override should be applied to internal requests.
Gets or sets a value indicating whether the override should be applied to external requests.
A playlist creation request.
Gets or sets the name.
Gets or sets the list of items.
Gets or sets the media type.
Gets or sets the user id.
Gets or sets the user permissions.
Gets or sets a value indicating whether the playlist is public.
Initializes a new instance of the class.
The playlist identifier.
A playlist update request.
Gets or sets the id of the playlist.
Gets or sets the id of the user updating the playlist.
Gets or sets the name of the playlist.
Gets or sets item ids to add to the playlist.
Gets or sets the playlist users.
Gets or sets a value indicating whether the playlist is public.
A playlist user update request.
Gets or sets the id of the playlist.
Gets or sets the id of the updated user.
Gets or sets a value indicating whether the user can edit the playlist.
Class BasePluginConfiguration.
Gets the plugin pages.
The plugin pages.
This is a serializable stub class that is used by the api to provide information about installed plugins.
Initializes a new instance of the class.
The plugin name.
The plugin .
The plugin description.
The .
True if this plugin can be uninstalled.
Gets or sets the name.
Gets or sets the version.
Gets or sets the name of the configuration file.
Gets or sets the description.
Gets or sets the unique id.
Gets or sets a value indicating whether the plugin can be uninstalled.
Gets or sets a value indicating whether this plugin has a valid image.
Gets or sets a value indicating the status of the plugin.
Defines the .
Gets or sets the name of the plugin.
Gets or sets the display name of the plugin.
Gets or sets the resource path.
Gets or sets a value indicating whether this plugin should appear in the main menu.
Gets or sets the menu section.
Gets or sets the menu icon.
Plugin load status.
This plugin requires a restart in order for it to load. This is a memory only status.
The actual status of the plugin after reload is present in the manifest.
eg. A disabled plugin will still be active until the next restart, and so will have a memory status of Restart,
but a disk manifest status of Disabled.
This plugin is currently running.
This plugin has been marked as disabled.
This plugin does not meet the TargetAbi requirements.
This plugin caused an error when instantiated (either DI loop, or exception).
This plugin has been superseded by another version.
[DEPRECATED] See Superseded.
An attempt to remove this plugin from disk will happen at every restart.
It will not be loaded, if unable to do so.
Represents the external id information for serialization to the client.
Initializes a new instance of the class.
Name of the external id provider (IE: IMDB, MusicBrainz, etc).
Key for this id. This key should be unique across all providers.
Specific media type for this id.
Gets or sets the display name of the external id provider (IE: IMDB, MusicBrainz, etc).
Gets or sets the unique key for this id. This key should be unique across all providers.
Gets or sets the specific media type for this id. This is used to distinguish between the different
external id types for providers with multiple ids.
A null value indicates there is no specific media type associated with the external id, or this is the
default id for the external provider so there is no need to specify a type.
This can be used along with the to localize the external id on the client.
The specific media type of an .
Client applications may use this as a translation key.
A music album.
The artist of a music album.
The artist of a media item.
A boxed set of media.
A series episode.
A movie.
An alternative artist apart from the main artist.
A person.
A release group.
A single season of a series.
A series.
A music track.
A book.
A music recording.
Gets or sets the name.
The name.
Gets or sets the type of the item.
The type of the item.
Class ImageProviderInfo.
Initializes a new instance of the class.
The name of the image provider.
The image types supported by the image provider.
Gets the name.
The name.
Gets the supported image types.
Lyric provider info.
Gets the provider name.
Gets the provider id.
Class RemoteImageInfo.
Gets or sets the name of the provider.
The name of the provider.
Gets or sets the URL.
The URL.
Gets or sets a url used for previewing a smaller version.
Gets or sets the height.
The height.
Gets or sets the width.
The width.
Gets or sets the community rating.
The community rating.
Gets or sets the vote count.
The vote count.
Gets or sets the language.
The language.
Gets or sets the type.
The type.
Gets or sets the type of the rating.
The type of the rating.
Initializes a new instance of the class.
The name of the image provider.
Class RemoteImageResult.
Gets or sets the images.
The images.
Gets or sets the total record count.
The total record count.
Gets or sets the providers.
The providers.
The remote lyric info.
Gets or sets the id for the lyric.
Gets the provider name.
Gets the lyric metadata.
Gets the lyrics.
Initializes a new instance of the class.
Gets or sets the name.
The name.
Gets or sets the provider ids.
The provider ids.
Gets or sets the year.
The year.
Initializes a new instance of the class.
Initializes a new instance of the class.
Used to control the data that gets attached to DtoBaseItems.
The air time.
The can delete.
The can download.
The channel information.
The chapters.
The trickplay manifest.
The child count.
The cumulative run time ticks.
The custom rating.
The date created of the item.
The date last media added.
Item display preferences.
The etag.
The external urls.
Genres.
The item counts.
The media source count.
The media versions.
The original title.
The item overview.
The id of the item's parent.
The physical path of the item.
The list of people for the item.
Value indicating whether playback access is granted.
The production locations.
The ids from IMDb, TMDb, etc.
The aspect ratio of the primary image.
The recursive item count.
The settings.
The series studio.
The sort name of the item.
The special episode numbers.
The studios of the item.
The taglines of the item.
The tags.
The trailer url of the item.
The media streams.
The season user data.
The last time metadata was refreshed.
The last time metadata was saved.
The refresh state.
The channel image.
Value indicating whether media source display is enabled.
The width.
The height.
The external Ids.
The local trailer count.
Value indicating whether the item is HD.
The special feature count.
Enum ItemFilter.
The item is a folder.
The item is not folder.
The item is unplayed.
The item is played.
The item is a favorite.
The item is resumable.
The likes.
The dislikes.
The is favorite or likes.
Initializes a new instance of the class.
Gets or sets the user to localize search results for.
The user id.
Gets or sets the parent id.
Specify this to localize the search to a specific item or folder. Omit to use the root.
The parent id.
Gets or sets the start index. Used for paging.
The start index.
Gets or sets the maximum number of items to return.
The limit.
Gets or sets the fields to return within the items, in addition to basic information.
The fields.
Gets or sets the include item types.
The include item types.
Gets or sets a value indicating whether this instance is played.
null if [is played] contains no value, true if [is played]; otherwise, false.
Gets or sets a value indicating whether [group items].
true if [group items]; otherwise, false.
Gets or sets a value indicating whether [enable images].
null if [enable images] contains no value, true if [enable images]; otherwise, false.
Gets or sets the image type limit.
The image type limit.
Gets or sets the enable image types.
The enable image types.
Initializes a new instance of the class.
Gets or sets the user.
The user.
Gets or sets the parent identifier.
The parent identifier.
Gets or sets the series id.
The series id.
Gets or sets the start index. Use for paging.
The start index.
Gets or sets the maximum number of items to return.
The limit.
Gets or sets the enable image types.
The enable image types.
Gets or sets a value indicating the oldest date for a show to appear in Next Up.
Gets or sets a value indicating whether to include resumable episodes as next up.
Gets or sets a value indicating whether getting rewatching next up list.
Initializes a new instance of the class.
Initializes a new instance of the class.
Query result container.
The type of item contained in the query result.
Initializes a new instance of the class.
Initializes a new instance of the class.
The list of items.
Initializes a new instance of the class.
The start index that was used to build the item list.
The total count of items.
The list of items.
Gets or sets the items.
The items.
Gets or sets the total number of records available.
The total record count.
Gets or sets the index of the first record in Items.
First record index.
Class ThemeMediaResult.
Gets or sets the owner id.
The owner id.
Stores the state of an quick connect request.
Initializes a new instance of the class.
The secret used to query the request state.
The code used to allow the request.
The time when the request was created.
The requesting device id.
The requesting device name.
The requesting app name.
The requesting app version.
Gets or sets a value indicating whether this request is authorized.
Gets the secret value used to uniquely identify this request. Can be used to retrieve authentication information.
Gets the user facing code used so the user can quickly differentiate this request from others.
Gets the requesting device id.
Gets the requesting device name.
Gets the requesting app name.
Gets the requesting app version.
Gets or sets the DateTime that this request was created.
Class SearchHintResult.
Initializes a new instance of the class.
Gets or sets the item id.
The item id.
Gets or sets the item id.
The item id.
Gets or sets the name.
The name.
Gets or sets the matched term.
The matched term.
Gets or sets the index number.
The index number.
Gets or sets the production year.
The production year.
Gets or sets the parent index number.
The parent index number.
Gets or sets the image tag.
The image tag.
Gets or sets the thumb image tag.
The thumb image tag.
Gets or sets the thumb image item identifier.
The thumb image item identifier.
Gets or sets the backdrop image tag.
The backdrop image tag.
Gets or sets the backdrop image item identifier.
The backdrop image item identifier.
Gets or sets the type.
The type.
Gets or sets a value indicating whether this instance is folder.
true if this instance is folder; otherwise, false.
Gets or sets the run time ticks.
The run time ticks.
Gets or sets the type of the media.
The type of the media.
Gets or sets the start date.
The start date.
Gets or sets the end date.
The end date.
Gets or sets the series.
The series.
Gets or sets the status.
The status.
Gets or sets the album.
The album.
Gets or sets the album id.
The album id.
Gets or sets the album artist.
The album artist.
Gets or sets the artists.
The artists.
Gets or sets the song count.
The song count.
Gets or sets the episode count.
The episode count.
Gets or sets the channel identifier.
The channel identifier.
Gets or sets the name of the channel.
The name of the channel.
Gets or sets the primary image aspect ratio.
The primary image aspect ratio.
Class SearchHintResult.
Initializes a new instance of the class.
The search hints.
The total record count.
Gets the search hints.
The search hints.
Gets the total record count.
The total record count.
Initializes a new instance of the class.
Gets or sets the user to localize search results for.
The user id.
Gets or sets the search term.
The search term.
Gets or sets the start index. Used for paging.
The start index.
Gets or sets the maximum number of items to return.
The limit.
Deserializes from stream.
The type.
The stream.
System.Object.
Serializes to stream.
The obj.
The stream.
Serializes to file.
The obj.
The file.
Deserializes from file.
The type.
The file.
System.Object.
Deserializes from bytes.
The type.
The buffer.
System.Object.
Class BrowseRequest.
Gets or sets the item type.
The type of the item.
Gets or sets the item id.
The item id.
Gets or sets the name of the item.
The name of the item.
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a new instance of the class.
The command arguments.
This exists simply to identify a set of known commands.
Enum PlaybackOrder.
Sorted playlist.
Shuffled playlist.
Class PlaybackProgressInfo.
Gets or sets a value indicating whether this instance can seek.
true if this instance can seek; otherwise, false.
Gets or sets the item.
The item.
Gets or sets the item identifier.
The item identifier.
Gets or sets the session id.
The session id.
Gets or sets the media version identifier.
The media version identifier.
Gets or sets the index of the audio stream.
The index of the audio stream.
Gets or sets the index of the subtitle stream.
The index of the subtitle stream.
Gets or sets a value indicating whether this instance is paused.
true if this instance is paused; otherwise, false.
Gets or sets a value indicating whether this instance is muted.
true if this instance is muted; otherwise, false.
Gets or sets the position ticks.
The position ticks.
Gets or sets the volume level.
The volume level.
Gets or sets the play method.
The play method.
Gets or sets the live stream identifier.
The live stream identifier.
Gets or sets the play session identifier.
The play session identifier.
Gets or sets the repeat mode.
The repeat mode.
Gets or sets the playback order.
The playback order.
Class PlaybackStartInfo.
Class PlaybackStopInfo.
Gets or sets the item.
The item.
Gets or sets the item identifier.
The item identifier.
Gets or sets the session id.
The session id.
Gets or sets the media version identifier.
The media version identifier.
Gets or sets the position ticks.
The position ticks.
Gets or sets the live stream identifier.
The live stream identifier.
Gets or sets the play session identifier.
The play session identifier.
Gets or sets a value indicating whether this is failed.
true if failed; otherwise, false.
Enum PlayCommand.
The play now.
The play next.
The play last.
The play instant mix.
The play shuffle.
Gets or sets the now playing position ticks.
The now playing position ticks.
Gets or sets a value indicating whether this instance can seek.
true if this instance can seek; otherwise, false.
Gets or sets a value indicating whether this instance is paused.
true if this instance is paused; otherwise, false.
Gets or sets a value indicating whether this instance is muted.
true if this instance is muted; otherwise, false.
Gets or sets the volume level.
The volume level.
Gets or sets the index of the now playing audio stream.
The index of the now playing audio stream.
Gets or sets the index of the now playing subtitle stream.
The index of the now playing subtitle stream.
Gets or sets the now playing media version identifier.
The now playing media version identifier.
Gets or sets the play method.
The play method.
Gets or sets the repeat mode.
The repeat mode.
Gets or sets the playback order.
The playback order.
Gets or sets the now playing live stream identifier.
The live stream identifier.
Class PlayRequest.
Gets or sets the item ids.
The item ids.
Gets or sets the start position ticks that the first item should be played at.
The start position ticks.
Gets or sets the play command.
The play command.
Gets or sets the controlling user identifier.
The controlling user identifier.
Enum PlaystateCommand.
The stop.
The pause.
The unpause.
The next track.
The previous track.
The seek.
The rewind.
The fast forward.
The play pause.
Gets or sets the controlling user identifier.
The controlling user identifier.
The different kinds of messages that are used in the WebSocket api.
Class SessionUserInfo.
Gets or sets the user identifier.
The user identifier.
Gets or sets the name of the user.
The name of the user.
Class holding information on a running transcode.
Gets or sets the thread count used for encoding.
Gets or sets the thread count used for encoding.
Gets or sets the thread count used for encoding.
Gets or sets a value indicating whether the video is passed through.
Gets or sets a value indicating whether the audio is passed through.
Gets or sets the bitrate.
Gets or sets the framerate.
Gets or sets the completion percentage.
Gets or sets the video width.
Gets or sets the video height.
Gets or sets the audio channels.
Gets or sets the hardware acceleration type.
Gets or sets the transcode reasons.
Class UserDataChangeInfo.
Gets or sets the user id.
The user id.
Gets or sets the user data list.
The user data list.
Class FontFile.
Gets or sets the name.
The name.
Gets or sets the size.
The size.
Gets or sets the date created.
The date created.
Gets or sets the date modified.
The date modified.
Class GroupInfoDto.
Initializes a new instance of the class.
The group identifier.
The group name.
The group state.
The participants.
The date when this DTO has been created.
Gets the group identifier.
The group identifier.
Gets the group name.
The group name.
Gets the group state.
The group state.
Gets the participants.
The participants.
Gets the date when this DTO has been created.
The date when this DTO has been created.
Enum GroupQueueMode.
Insert items at the end of the queue.
Insert items after the currently playing item.
Enum GroupRepeatMode.
Repeat one item only.
Cycle the playlist.
Do not repeat.
Enum GroupShuffleMode.
Sorted playlist.
Shuffled playlist.
Enum GroupState.
The group is in idle state. No media is playing.
The group is in waiting state. Playback is paused. Will start playing when users are ready.
The group is in paused state. Playback is paused. Will resume on play command.
The group is in playing state. Playback is advancing.
Class GroupStateUpdate.
Initializes a new instance of the class.
The state of the group.
The reason of the state change.
Gets the state of the group.
The state of the group.
Gets the reason of the state change.
The reason of the state change.
Group update without data.
The type of the update data.
Initializes a new instance of the class.
The group identifier.
The update data.
Gets the group identifier.
The group identifier.
Gets the update data.
The update data.
Gets the update type.
The update type.
Enum GroupUpdateType.
The user-joined update. Tells members of a group about a new user.
The user-left update. Tells members of a group that a user left.
The group-joined update. Tells a user that the group has been joined.
The group-left update. Tells a user that the group has been left.
The group-state update. Tells members of the group that the state changed.
The play-queue update. Tells a user the playing queue of the group.
The not-in-group error. Tells a user that they don't belong to a group.
The group-does-not-exist error. Sent when trying to join a non-existing group.
The library-access-denied error. Sent when a user tries to join a group without required access to the library.
Enum PlaybackRequestType.
A user is setting a new playlist.
A user is changing the playlist item.
A user is removing items from the playlist.
A user is moving an item in the playlist.
A user is adding items to the playlist.
A user is requesting an unpause command for the group.
A user is requesting a pause command for the group.
A user is requesting a stop command for the group.
A user is requesting a seek command for the group.
A user is signaling that playback is buffering.
A user is signaling that playback resumed.
A user is requesting next item in playlist.
A user is requesting previous item in playlist.
A user is setting the repeat mode.
A user is setting the shuffle mode.
A user is reporting their ping.
A user is requesting to be ignored on group wait.
Class PlayQueueUpdate.
Initializes a new instance of the class.
The reason for the update.
The UTC time of the last change to the playing queue.
The playlist.
The playing item index in the playlist.
The start position ticks.
The playing item status.
The shuffle mode.
The repeat mode.
Gets the request type that originated this update.
The reason for the update.
Gets the UTC time of the last change to the playing queue.
The UTC time of the last change to the playing queue.
Gets the playlist.
The playlist.
Gets the playing item index in the playlist.
The playing item index in the playlist.
Gets the start position ticks.
The start position ticks.
Gets a value indicating whether the current item is playing.
The playing item status.
Gets the shuffle mode.
The shuffle mode.
Gets the repeat mode.
The repeat mode.
Enum PlayQueueUpdateReason.
A user is requesting to play a new playlist.
A user is changing the playing item.
A user is removing items from the playlist.
A user is moving an item in the playlist.
A user is adding items the queue.
A user is adding items to the queue, after the currently playing item.
A user is requesting the next item in queue.
A user is requesting the previous item in queue.
A user is changing repeat mode.
A user is changing shuffle mode.
Enum RequestType.
A user is requesting to create a new group.
A user is requesting to join a group.
A user is requesting to leave a group.
A user is requesting the list of available groups.
A user is sending a playback command to a group.
Class SendCommand.
Initializes a new instance of the class.
The group identifier.
The playlist identifier of the playing item.
The UTC time when to execute the command.
The command.
The position ticks, for commands that require it.
The UTC time when this command has been emitted.
Gets the group identifier.
The group identifier.
Gets the playlist identifier of the playing item.
The playlist identifier of the playing item.
Gets or sets the UTC time when to execute the command.
The UTC time when to execute the command.
Gets the position ticks.
The position ticks.
Gets the command.
The command.
Gets the UTC time when this command has been emitted.
The UTC time when this command has been emitted.
Enum SendCommandType.
The unpause command. Instructs users to unpause playback.
The pause command. Instructs users to pause playback.
The stop command. Instructs users to stop playback.
The seek command. Instructs users to seek to a specified time.
Used to filter the sessions of a group.
All sessions will receive the message.
Only the specified session will receive the message.
All sessions, except the current one, will receive the message.
Only sessions that are not buffering will receive the message.
Initializes a new instance of the class.
The groupId.
The data.
Initializes a new instance of the class.
The groupId.
The data.
Initializes a new instance of the class.
The groupId.
The data.
Initializes a new instance of the class.
The groupId.
The data.
Initializes a new instance of the class.
The groupId.
The data.
Initializes a new instance of the class.
The groupId.
The data.
Class QueueItem.
Initializes a new instance of the class.
The item identifier.
Gets the item identifier.
The item identifier.
Gets the playlist identifier of the item.
The playlist identifier of the item.
Initializes a new instance of the class.
The groupId.
The data.
Initializes a new instance of the class.
The groupId.
The data.
Initializes a new instance of the class.
The groupId.
The data.
Class UtcTimeResponse.
Initializes a new instance of the class.
The UTC time when request has been received.
The UTC time when response has been sent.
Gets the UTC time when request has been received.
The UTC time when request has been received.
Gets the UTC time when response has been sent.
The UTC time when response has been sent.
The cast receiver application model.
Gets or sets the cast receiver application id.
Gets or sets the cast receiver application name.
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.
Gets or sets the date created.
The date created.
Gets or sets the date modified.
The date modified.
Gets or sets the size.
The size.
Gets or sets the name.
The name.
Gets or sets the local address.
The local address.
Gets or sets the name of the server.
The name of the server.
Gets or sets the server version.
The version.
Gets or sets the product name. This is the AssemblyProduct name.
Gets or sets the operating system.
The operating system.
Gets or sets the id.
The id.
Gets or sets a value indicating whether the startup wizard is completed.
Nullable for OpenAPI specification only to retain backwards compatibility in api clients.
The startup completion status.]
Class SystemInfo.
Initializes a new instance of the class.
Gets or sets the display name of the operating system.
The display name of the operating system.
Gets or sets the package name.
The value of the '-package' command line argument.
Gets or sets a value indicating whether this instance has pending restart.
true if this instance has pending restart; otherwise, false.
Gets or sets a value indicating whether [supports library monitor].
true if [supports library monitor]; otherwise, false.
Gets or sets the web socket port number.
The web socket port number.
Gets or sets the completed installations.
The completed installations.
Gets or sets a value indicating whether this instance can self restart.
true.
Gets or sets the program data path.
The program data path.
Gets or sets the web UI resources path.
The web UI resources path.
Gets or sets the items by name path.
The items by name path.
Gets or sets the cache path.
The cache path.
Gets or sets the log path.
The log path.
Gets or sets the internal metadata path.
The internal metadata path.
Gets or sets the transcode path.
The transcode path.
Gets or sets the list of cast receiver applications.
Gets or sets a value indicating whether this instance has update available.
true if this instance has update available; otherwise, false.
Contains informations about the systems storage.
Gets or sets the program data path.
The program data path.
Gets or sets the web UI resources path.
The web UI resources path.
Gets or sets the items by name path.
The items by name path.
Gets or sets the cache path.
The cache path.
Gets or sets the log path.
The log path.
Gets or sets the internal metadata path.
The internal metadata path.
Gets or sets the transcode path.
The transcode path.
Gets or sets the storage informations of all libraries.
Interface for configurable scheduled tasks.
Gets a value indicating whether this instance is hidden.
true if this instance is hidden; otherwise, false.
Gets a value indicating whether this instance is enabled.
true if this instance is enabled; otherwise, false.
Gets a value indicating whether this instance is logged.
true if this instance is logged; otherwise, false.
Interface IScheduledTaskWorker.
Gets the name of the task.
The name.
Gets the key of the task.
Gets the description.
The description.
Gets the category.
The category.
Executes the task.
The progress.
The cancellation token.
Task.
Gets the default triggers that define when the task will run.
The default triggers that define when the task will run.
Interface IScheduledTaskWorker.
Occurs when [task progress].
Gets the scheduled task.
The scheduled task.
Gets the last execution result.
The last execution result.
Gets the name.
The name.
Gets the description.
The description.
Gets the category.
The category.
Gets the state.
The state.
Gets the current progress.
The current progress.
Gets or sets the triggers that define when the task will run.
The triggers.
Gets the unique id.
The unique id.
Reloads the trigger events.
Interface for the TaskManager class.
Event handler for task execution.
Event handler for task completion.
Gets the list of Scheduled Tasks.
The scheduled tasks.
Cancels if running and queue.
An implementation of .
Task options.
Cancels if running and queue.
An implementation of .
Cancels if running.
An implementation of .
Queues the scheduled task.
An implementation of .
Task options.
Queues the scheduled task.
An implementation of .
Queues the scheduled task if it is not already running.
An implementation of .
Queues the scheduled task.
The to queue.
The to use.
Adds the tasks.
The tasks.
Adds the tasks.
The tasks.
Executes the tasks.
The tasks.
The options.
The executed tasks.
Executes the tasks.
An implementation of .
Interface ITaskTrigger.
Fires when the trigger condition is satisfied and the task should run.
Gets the options of this task.
Stars waiting for the trigger action.
Result of the last run triggered task.
The .
The name of the task.
Whether or not this is fired during startup.
Stops waiting for the trigger action.
Class ScheduledTaskHelpers.
Gets the task info.
The task.
TaskInfo.
Class containing event arguments for task completion.
Initializes a new instance of the class.
Instance of the interface.
The task result.
Gets the task.
The task.
Gets the result.
The result.
Enum TaskCompletionStatus.
The completed.
The failed.
Manually cancelled by the user.
Aborted due to a system failure or shutdown.
Class TaskInfo.
Initializes a new instance of the class.
Gets or sets the name.
The name.
Gets or sets the state of the task.
The state of the task.
Gets or sets the progress.
The progress.
Gets or sets the id.
The id.
Gets or sets the last execution result.
The last execution result.
Gets or sets the triggers.
The triggers.
Gets or sets the description.
The description.
Gets or sets the category.
The category.
Gets or sets a value indicating whether this instance is hidden.
true if this instance is hidden; otherwise, false.
Gets or sets the key.
The key.
Class containing options for tasks.
Gets or sets the maximum runtime in ticks.
The ticks.
Class TaskExecutionInfo.
Gets or sets the start time UTC.
The start time UTC.
Gets or sets the end time UTC.
The end time UTC.
Gets or sets the status.
The status.
Gets or sets the name.
The name.
Gets or sets the key.
The key.
Gets or sets the id.
The id.
Gets or sets the error message.
The error message.
Gets or sets the long error message.
The long error message.
Enum TaskState.
The idle.
The cancelling.
The running.
Class TaskTriggerInfo.
Gets or sets the type.
The type.
Gets or sets the time of day.
The time of day.
Gets or sets the interval.
The interval.
Gets or sets the day of week.
The day of week.
Gets or sets the maximum runtime ticks.
The maximum runtime ticks.
Enum TaskTriggerInfoType.
The daily trigger.
The weekly trigger.
The interval trigger.
The startup trigger.
Class InstallationInfo.
Gets or sets the Id.
The Id.
Gets or sets the name.
The name.
Gets or sets the version.
The version.
Gets or sets the changelog for this version.
The changelog.
Gets or sets the source URL.
The source URL.
Gets or sets a checksum for the binary.
The checksum.
Gets or sets package information for the installation.
The package information.
Class PackageInfo.
Initializes a new instance of the class.
Gets or sets the name.
The name.
Gets or sets a long description of the plugin containing features or helpful explanations.
The description.
Gets or sets a short overview of what the plugin does.
The overview.
Gets or sets the owner.
The owner.
Gets or sets the category.
The category.
Gets or sets the guid of the assembly associated with this plugin.
This is used to identify the proper item for automatic updates.
The name.
Gets or sets the versions.
The versions.
Gets or sets the image url for the package.
Class RepositoryInfo.
Gets or sets the name.
The name.
Gets or sets the URL.
The URL.
Gets or sets a value indicating whether the repository is enabled.
true if enabled.
Defines the class.
Gets or sets the version.
The version.
Gets the version as a .
Gets or sets the changelog for this version.
The changelog.
Gets or sets the ABI that this version was built against.
The target ABI version.
Gets or sets the source URL.
The source URL.
Gets or sets a checksum for the binary.
The checksum.
Gets or sets a timestamp of when the binary was built.
The timestamp.
Gets or sets the repository name.
Gets or sets the repository url.
Gets or sets the action.
The action.
Gets or sets the pin file.
The pin file.
Gets or sets the pin expiration date.
The pin expiration date.
Gets or sets a value indicating whether this is success.
true if success; otherwise, false.
Gets or sets the users reset.
The users reset.
Gets or sets a value indicating whether this instance is administrator.
true if this instance is administrator; otherwise, false.
Gets or sets a value indicating whether this instance is hidden.
true if this instance is hidden; otherwise, false.
Gets or sets a value indicating whether this instance can manage collections.
true if this instance is hidden; otherwise, false.
Gets or sets a value indicating whether this instance can manage subtitles.
true if this instance is allowed; otherwise, false.
Gets or sets a value indicating whether this user can manage lyrics.
Gets or sets a value indicating whether this instance is disabled.
true if this instance is disabled; otherwise, false.
Gets or sets the max parental rating.
The max parental rating.
Gets or sets a value indicating whether [enable synchronize].
true if [enable synchronize]; otherwise, false.
Gets or sets a value indicating what SyncPlay features the user can access.
Access level to SyncPlay features.
Provides utilities for mapping file names and extensions to MIME-types.
The fallback MIME-type. Defaults to application/octet-stream.
Attempts to fetch all available file extensions for a MIME-type.
The name of the MIME-type
All available extensions for the given MIME-type
Tries to get the MIME-type for the given file name.
The name of the file.
The MIME-type for the given file name.
true if a MIME-type was found, false otherwise.
Gets the MIME-type for the given file name,
or if a mapping doesn't exist.
The name of the file.
The MIME-type for the given file name.