@jellyfin/sdk 0.8.2 → 0.10.0

package/lib/generated-client/models/device-profile.d.ts

@@ -10,12 +10,9 @@
  */
 import { CodecProfile } from './codec-profile';
 import { ContainerProfile } from './container-profile';
-import { DeviceIdentification } from './device-identification';
 import { DirectPlayProfile } from './direct-play-profile';
-import { ResponseProfile } from './response-profile';
 import { SubtitleProfile } from './subtitle-profile';
 import { TranscodingProfile } from './transcoding-profile';
-import { XmlAttribute } from './xml-attribute';
 /**
  * A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play.  <br />  Specifically, it defines the supported <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.ContainerProfiles\">containers</see> and  <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.CodecProfiles\">codecs</see> (video and/or audio, including codec profiles and levels)  the device is able to direct play (without transcoding or remuxing),  as well as which <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.TranscodingProfiles\">containers/codecs to transcode to</see> in case it isn\'t.
  * @export
@@ -34,120 +31,6 @@ export interface DeviceProfile {
      * @memberof DeviceProfile
      */
     'Id'?: string | null;
-    /**
-     *
-     * @type {DeviceIdentification}
-     * @memberof DeviceProfile
-     */
-    'Identification'?: DeviceIdentification;
-    /**
-     * Gets or sets the friendly name of the device profile, which can be shown to users.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'FriendlyName'?: string | null;
-    /**
-     * Gets or sets the manufacturer of the device which this profile represents.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'Manufacturer'?: string | null;
-    /**
-     * Gets or sets an url for the manufacturer of the device which this profile represents.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'ManufacturerUrl'?: string | null;
-    /**
-     * Gets or sets the model name of the device which this profile represents.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'ModelName'?: string | null;
-    /**
-     * Gets or sets the model description of the device which this profile represents.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'ModelDescription'?: string | null;
-    /**
-     * Gets or sets the model number of the device which this profile represents.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'ModelNumber'?: string | null;
-    /**
-     * Gets or sets the ModelUrl.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'ModelUrl'?: string | null;
-    /**
-     * Gets or sets the serial number of the device which this profile represents.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'SerialNumber'?: string | null;
-    /**
-     * Gets or sets a value indicating whether EnableAlbumArtInDidl.
-     * @type {boolean}
-     * @memberof DeviceProfile
-     */
-    'EnableAlbumArtInDidl'?: boolean;
-    /**
-     * Gets or sets a value indicating whether EnableSingleAlbumArtLimit.
-     * @type {boolean}
-     * @memberof DeviceProfile
-     */
-    'EnableSingleAlbumArtLimit'?: boolean;
-    /**
-     * Gets or sets a value indicating whether EnableSingleSubtitleLimit.
-     * @type {boolean}
-     * @memberof DeviceProfile
-     */
-    'EnableSingleSubtitleLimit'?: boolean;
-    /**
-     * Gets or sets the SupportedMediaTypes.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'SupportedMediaTypes'?: string;
-    /**
-     * Gets or sets the UserId.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'UserId'?: string | null;
-    /**
-     * Gets or sets the AlbumArtPn.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'AlbumArtPn'?: string | null;
-    /**
-     * Gets or sets the MaxAlbumArtWidth.
-     * @type {number}
-     * @memberof DeviceProfile
-     */
-    'MaxAlbumArtWidth'?: number | null;
-    /**
-     * Gets or sets the MaxAlbumArtHeight.
-     * @type {number}
-     * @memberof DeviceProfile
-     */
-    'MaxAlbumArtHeight'?: number | null;
-    /**
-     * Gets or sets the maximum allowed width of embedded icons.
-     * @type {number}
-     * @memberof DeviceProfile
-     */
-    'MaxIconWidth'?: number | null;
-    /**
-     * Gets or sets the maximum allowed height of embedded icons.
-     * @type {number}
-     * @memberof DeviceProfile
-     */
-    'MaxIconHeight'?: number | null;
     /**
      * Gets or sets the maximum allowed bitrate for all streamed content.
      * @type {number}
@@ -172,54 +55,6 @@ export interface DeviceProfile {
      * @memberof DeviceProfile
      */
     'MaxStaticMusicBitrate'?: number | null;
-    /**
-     * Gets or sets the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'SonyAggregationFlags'?: string | null;
-    /**
-     * Gets or sets the ProtocolInfo.
-     * @type {string}
-     * @memberof DeviceProfile
-     */
-    'ProtocolInfo'?: string | null;
-    /**
-     * Gets or sets the TimelineOffsetSeconds.
-     * @type {number}
-     * @memberof DeviceProfile
-     */
-    'TimelineOffsetSeconds'?: number;
-    /**
-     * Gets or sets a value indicating whether RequiresPlainVideoItems.
-     * @type {boolean}
-     * @memberof DeviceProfile
-     */
-    'RequiresPlainVideoItems'?: boolean;
-    /**
-     * Gets or sets a value indicating whether RequiresPlainFolders.
-     * @type {boolean}
-     * @memberof DeviceProfile
-     */
-    'RequiresPlainFolders'?: boolean;
-    /**
-     * Gets or sets a value indicating whether EnableMSMediaReceiverRegistrar.
-     * @type {boolean}
-     * @memberof DeviceProfile
-     */
-    'EnableMSMediaReceiverRegistrar'?: boolean;
-    /**
-     * Gets or sets a value indicating whether IgnoreTranscodeByteRangeRequests.
-     * @type {boolean}
-     * @memberof DeviceProfile
-     */
-    'IgnoreTranscodeByteRangeRequests'?: boolean;
-    /**
-     * Gets or sets the XmlRootAttributes.
-     * @type {Array<XmlAttribute>}
-     * @memberof DeviceProfile
-     */
-    'XmlRootAttributes'?: Array<XmlAttribute>;
     /**
      * Gets or sets the direct play profiles.
      * @type {Array<DirectPlayProfile>}
@@ -244,12 +79,6 @@ export interface DeviceProfile {
      * @memberof DeviceProfile
      */
     'CodecProfiles'?: Array<CodecProfile>;
-    /**
-     * Gets or sets the ResponseProfiles.
-     * @type {Array<ResponseProfile>}
-     * @memberof DeviceProfile
-     */
-    'ResponseProfiles'?: Array<ResponseProfile>;
     /**
      * Gets or sets the subtitle profiles.
      * @type {Array<SubtitleProfile>}

package/lib/generated-client/models/dlna-profile-type.d.ts

@@ -18,5 +18,6 @@ export declare const DlnaProfileType: {
     readonly Video: "Video";
     readonly Photo: "Photo";
     readonly Subtitle: "Subtitle";
+    readonly Lyric: "Lyric";
 };
 export type DlnaProfileType = typeof DlnaProfileType[keyof typeof DlnaProfileType];

package/lib/generated-client/models/dlna-profile-type.js

@@ -19,7 +19,8 @@ const DlnaProfileType = {
     Audio: 'Audio',
     Video: 'Video',
     Photo: 'Photo',
-    Subtitle: 'Subtitle'
+    Subtitle: 'Subtitle',
+    Lyric: 'Lyric'
 };
 
 export { DlnaProfileType };

package/lib/generated-client/models/down-mix-stereo-algorithms.d.ts

@@ -0,0 +1,21 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+/**
+ * An enum representing an algorithm to downmix 6ch+ to stereo.  Algorithms sourced from https://superuser.com/questions/852400/properly-downmix-5-1-to-stereo-using-ffmpeg/1410620#1410620.
+ * @export
+ * @enum {string}
+ */
+export declare const DownMixStereoAlgorithms: {
+    readonly None: "None";
+    readonly Dave750: "Dave750";
+    readonly NightmodeDialogue: "NightmodeDialogue";
+};
+export type DownMixStereoAlgorithms = typeof DownMixStereoAlgorithms[keyof typeof DownMixStereoAlgorithms];

package/lib/generated-client/models/down-mix-stereo-algorithms.js

@@ -0,0 +1,24 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+/**
+ * An enum representing an algorithm to downmix 6ch+ to stereo.  Algorithms sourced from https://superuser.com/questions/852400/properly-downmix-5-1-to-stereo-using-ffmpeg/1410620#1410620.
+ * @export
+ * @enum {string}
+ */
+const DownMixStereoAlgorithms = {
+    None: 'None',
+    Dave750: 'Dave750',
+    NightmodeDialogue: 'NightmodeDialogue'
+};
+
+export { DownMixStereoAlgorithms };

package/lib/generated-client/models/encoding-options.d.ts

@@ -8,62 +8,87 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
+import { DownMixStereoAlgorithms } from './down-mix-stereo-algorithms';
 /**
- *
+ * Class EncodingOptions.
  * @export
  * @interface EncodingOptions
  */
 export interface EncodingOptions {
     /**
-     *
+     * Gets or sets the thread count used for encoding.
      * @type {number}
      * @memberof EncodingOptions
      */
     'EncodingThreadCount'?: number;
     /**
-     *
+     * Gets or sets the temporary transcoding path.
      * @type {string}
      * @memberof EncodingOptions
      */
     'TranscodingTempPath'?: string | null;
     /**
-     *
+     * Gets or sets the path to the fallback font.
      * @type {string}
      * @memberof EncodingOptions
      */
     'FallbackFontPath'?: string | null;
     /**
-     *
+     * Gets or sets a value indicating whether to use the fallback font.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'EnableFallbackFont'?: boolean;
     /**
-     *
+     * Gets or sets a value indicating whether audio VBR is enabled.
+     * @type {boolean}
+     * @memberof EncodingOptions
+     */
+    'EnableAudioVbr'?: boolean;
+    /**
+     * Gets or sets the audio boost applied when downmixing audio.
      * @type {number}
      * @memberof EncodingOptions
      */
     'DownMixAudioBoost'?: number;
     /**
      *
+     * @type {DownMixStereoAlgorithms}
+     * @memberof EncodingOptions
+     */
+    'DownMixStereoAlgorithm'?: DownMixStereoAlgorithms;
+    /**
+     * Gets or sets the maximum size of the muxing queue.
      * @type {number}
      * @memberof EncodingOptions
      */
     'MaxMuxingQueueSize'?: number;
     /**
-     *
+     * Gets or sets a value indicating whether throttling is enabled.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'EnableThrottling'?: boolean;
     /**
-     *
+     * Gets or sets the delay after which throttling happens.
      * @type {number}
      * @memberof EncodingOptions
      */
     'ThrottleDelaySeconds'?: number;
     /**
-     *
+     * Gets or sets a value indicating whether segment deletion is enabled.
+     * @type {boolean}
+     * @memberof EncodingOptions
+     */
+    'EnableSegmentDeletion'?: boolean;
+    /**
+     * Gets or sets seconds for which segments should be kept before being deleted.
+     * @type {number}
+     * @memberof EncodingOptions
+     */
+    'SegmentKeepSeconds'?: number;
+    /**
+     * Gets or sets the hardware acceleration type.
      * @type {string}
      * @memberof EncodingOptions
      */
@@ -81,163 +106,175 @@ export interface EncodingOptions {
      */
     'EncoderAppPathDisplay'?: string | null;
     /**
-     *
+     * Gets or sets the VA-API device.
      * @type {string}
      * @memberof EncodingOptions
      */
     'VaapiDevice'?: string | null;
     /**
-     *
+     * Gets or sets a value indicating whether tonemapping is enabled.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'EnableTonemapping'?: boolean;
     /**
-     *
+     * Gets or sets a value indicating whether VPP tonemapping is enabled.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'EnableVppTonemapping'?: boolean;
     /**
-     *
+     * Gets or sets a value indicating whether videotoolbox tonemapping is enabled.
+     * @type {boolean}
+     * @memberof EncodingOptions
+     */
+    'EnableVideoToolboxTonemapping'?: boolean;
+    /**
+     * Gets or sets the tone-mapping algorithm.
      * @type {string}
      * @memberof EncodingOptions
      */
     'TonemappingAlgorithm'?: string | null;
     /**
-     *
+     * Gets or sets the tone-mapping mode.
      * @type {string}
      * @memberof EncodingOptions
      */
-    'TonemappingRange'?: string | null;
+    'TonemappingMode'?: string | null;
     /**
-     *
-     * @type {number}
+     * Gets or sets the tone-mapping range.
+     * @type {string}
      * @memberof EncodingOptions
      */
-    'TonemappingDesat'?: number;
+    'TonemappingRange'?: string | null;
     /**
-     *
+     * Gets or sets the tone-mapping desaturation.
      * @type {number}
      * @memberof EncodingOptions
      */
-    'TonemappingThreshold'?: number;
+    'TonemappingDesat'?: number;
     /**
-     *
+     * Gets or sets the tone-mapping peak.
      * @type {number}
      * @memberof EncodingOptions
      */
     'TonemappingPeak'?: number;
     /**
-     *
+     * Gets or sets the tone-mapping parameters.
      * @type {number}
      * @memberof EncodingOptions
      */
     'TonemappingParam'?: number;
     /**
-     *
+     * Gets or sets the VPP tone-mapping brightness.
      * @type {number}
      * @memberof EncodingOptions
      */
     'VppTonemappingBrightness'?: number;
     /**
-     *
+     * Gets or sets the VPP tone-mapping contrast.
      * @type {number}
      * @memberof EncodingOptions
      */
     'VppTonemappingContrast'?: number;
     /**
-     *
+     * Gets or sets the H264 CRF.
      * @type {number}
      * @memberof EncodingOptions
      */
     'H264Crf'?: number;
     /**
-     *
+     * Gets or sets the H265 CRF.
      * @type {number}
      * @memberof EncodingOptions
      */
     'H265Crf'?: number;
     /**
-     *
+     * Gets or sets the encoder preset.
      * @type {string}
      * @memberof EncodingOptions
      */
     'EncoderPreset'?: string | null;
     /**
-     *
+     * Gets or sets a value indicating whether the framerate is doubled when deinterlacing.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'DeinterlaceDoubleRate'?: boolean;
     /**
-     *
+     * Gets or sets the deinterlace method.
      * @type {string}
      * @memberof EncodingOptions
      */
     'DeinterlaceMethod'?: string | null;
     /**
-     *
+     * Gets or sets a value indicating whether 10bit HEVC decoding is enabled.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'EnableDecodingColorDepth10Hevc'?: boolean;
     /**
-     *
+     * Gets or sets a value indicating whether 10bit VP9 decoding is enabled.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'EnableDecodingColorDepth10Vp9'?: boolean;
     /**
-     *
+     * Gets or sets a value indicating whether the enhanced NVDEC is enabled.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'EnableEnhancedNvdecDecoder'?: boolean;
     /**
-     *
+     * Gets or sets a value indicating whether the system native hardware decoder should be used.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'PreferSystemNativeHwDecoder'?: boolean;
     /**
-     *
+     * Gets or sets a value indicating whether the Intel H264 low-power hardware encoder should be used.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'EnableIntelLowPowerH264HwEncoder'?: boolean;
     /**
-     *
+     * Gets or sets a value indicating whether the Intel HEVC low-power hardware encoder should be used.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'EnableIntelLowPowerHevcHwEncoder'?: boolean;
     /**
-     *
+     * Gets or sets a value indicating whether hardware encoding is enabled.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'EnableHardwareEncoding'?: boolean;
     /**
-     *
+     * Gets or sets a value indicating whether HEVC encoding is enabled.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'AllowHevcEncoding'?: boolean;
     /**
-     *
+     * Gets or sets a value indicating whether AV1 encoding is enabled.
+     * @type {boolean}
+     * @memberof EncodingOptions
+     */
+    'AllowAv1Encoding'?: boolean;
+    /**
+     * Gets or sets a value indicating whether subtitle extraction is enabled.
      * @type {boolean}
      * @memberof EncodingOptions
      */
     'EnableSubtitleExtraction'?: boolean;
     /**
-     *
+     * Gets or sets the codecs hardware encoding is used for.
      * @type {Array<string>}
      * @memberof EncodingOptions
      */
     'HardwareDecodingCodecs'?: Array<string> | null;
     /**
-     *
+     * Gets or sets the file extensions on-demand metadata based keyframe extraction is enabled for.
      * @type {Array<string>}
      * @memberof EncodingOptions
      */

package/lib/generated-client/models/external-id-media-type.d.ts

@@ -26,5 +26,6 @@ export declare const ExternalIdMediaType: {
     readonly Season: "Season";
     readonly Series: "Series";
     readonly Track: "Track";
+    readonly Book: "Book";
 };
 export type ExternalIdMediaType = typeof ExternalIdMediaType[keyof typeof ExternalIdMediaType];

package/lib/generated-client/models/external-id-media-type.js

@@ -27,7 +27,8 @@ const ExternalIdMediaType = {
     ReleaseGroup: 'ReleaseGroup',
     Season: 'Season',
     Series: 'Series',
-    Track: 'Track'
+    Track: 'Track',
+    Book: 'Book'
 };
 
 export { ExternalIdMediaType };

package/lib/generated-client/models/extra-type.d.ts

@@ -0,0 +1,30 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const ExtraType: {
+    readonly Unknown: "Unknown";
+    readonly Clip: "Clip";
+    readonly Trailer: "Trailer";
+    readonly BehindTheScenes: "BehindTheScenes";
+    readonly DeletedScene: "DeletedScene";
+    readonly Interview: "Interview";
+    readonly Scene: "Scene";
+    readonly Sample: "Sample";
+    readonly ThemeSong: "ThemeSong";
+    readonly ThemeVideo: "ThemeVideo";
+    readonly Featurette: "Featurette";
+    readonly Short: "Short";
+};
+export type ExtraType = typeof ExtraType[keyof typeof ExtraType];

package/lib/generated-client/models/extra-type.js

@@ -0,0 +1,33 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+const ExtraType = {
+    Unknown: 'Unknown',
+    Clip: 'Clip',
+    Trailer: 'Trailer',
+    BehindTheScenes: 'BehindTheScenes',
+    DeletedScene: 'DeletedScene',
+    Interview: 'Interview',
+    Scene: 'Scene',
+    Sample: 'Sample',
+    ThemeSong: 'ThemeSong',
+    ThemeVideo: 'ThemeVideo',
+    Featurette: 'Featurette',
+    Short: 'Short'
+};
+
+export { ExtraType };

package/lib/generated-client/models/force-keep-alive-message.d.ts

@@ -0,0 +1,36 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+import { SessionMessageType } from './session-message-type';
+/**
+ * Force keep alive websocket messages.
+ * @export
+ * @interface ForceKeepAliveMessage
+ */
+export interface ForceKeepAliveMessage {
+    /**
+     * Gets or sets the data.
+     * @type {number}
+     * @memberof ForceKeepAliveMessage
+     */
+    'Data'?: number;
+    /**
+     * Gets or sets the message id.
+     * @type {string}
+     * @memberof ForceKeepAliveMessage
+     */
+    'MessageId'?: string;
+    /**
+     *
+     * @type {SessionMessageType}
+     * @memberof ForceKeepAliveMessage
+     */
+    'MessageType'?: SessionMessageType;
+}