--- title: "Authenticates a user." method: POST path: "/Users/{userId}/Authenticate" tags: ["User"] --- # Authenticates a user. `POST /Users/{userId}/Authenticate` ## Path parameters - `userId` string, uuid, required — The user id. ## Query parameters - `pw` string, required — The password as plain text. - `password` string, nullable — The password sha1-hash. ## Response `200` User authenticated. - AuthenticationResult - `User` UserDto — Class UserDto. - `Name` string, nullable — Gets or sets the name. - `ServerId` string, nullable — Gets or sets the server identifier. - `ServerName` string, nullable — Gets or sets the name of the server. This is not used by the server and is for client-side usage only. - `Id` string, uuid — Gets or sets the id. - `PrimaryImageTag` string, nullable — Gets or sets the primary image tag. - `HasPassword` boolean — Gets or sets a value indicating whether this instance has password. - `HasConfiguredPassword` boolean — Gets or sets a value indicating whether this instance has configured password. - `HasConfiguredEasyPassword` boolean — Gets or sets a value indicating whether this instance has configured easy password. - `EnableAutoLogin` boolean, nullable — Gets or sets whether async login is enabled or not. - `LastLoginDate` string, date-time, nullable — Gets or sets the last login date. - `LastActivityDate` string, date-time, nullable — Gets or sets the last activity date. - `Configuration` UserConfiguration — Class UserConfiguration. - `AudioLanguagePreference` string, nullable — Gets or sets the audio language preference. - `PlayDefaultAudioTrack` boolean — Gets or sets a value indicating whether [play default audio track]. - `SubtitleLanguagePreference` string, nullable — Gets or sets the subtitle language preference. - `DisplayMissingEpisodes` boolean - `GroupedFolders` string[], nullable - `SubtitleMode` 'Default' | 'Always' | 'OnlyForced' | 'None' | 'Smart' — An enum representing a subtitle playback mode. - `DisplayCollectionsView` boolean - `EnableLocalPassword` boolean - `OrderedViews` string[], nullable - `LatestItemsExcludes` string[], nullable - `MyMediaExcludes` string[], nullable - `HidePlayedInLatest` boolean - `RememberAudioSelections` boolean - `RememberSubtitleSelections` boolean - `EnableNextEpisodeAutoPlay` boolean - `Policy` UserPolicy - `IsAdministrator` boolean — Gets or sets a value indicating whether this instance is administrator. - `IsHidden` boolean — Gets or sets a value indicating whether this instance is hidden. - `IsDisabled` boolean — Gets or sets a value indicating whether this instance is disabled. - `MaxParentalRating` integer, nullable — Gets or sets the max parental rating. - `BlockedTags` string[], nullable - `EnableUserPreferenceAccess` boolean - `AccessSchedules` AccessSchedule[], nullable - `Id` integer, required — Gets or sets the id of this instance. - `UserId` string, uuid, required — Gets or sets the id of the associated user. - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Everyday' | 'Weekday' | 'Weekend', required — An enum that represents a day of the week, weekdays, weekends, or all days. - `StartHour` number, double, required — Gets or sets the start hour. - `EndHour` number, double, required — Gets or sets the end hour. - `BlockUnratedItems` UnratedItem[], nullable - `EnableRemoteControlOfOtherUsers` boolean - `EnableSharedDeviceControl` boolean - `EnableRemoteAccess` boolean - `EnableLiveTvManagement` boolean - `EnableLiveTvAccess` boolean - `EnableMediaPlayback` boolean - `EnableAudioPlaybackTranscoding` boolean - `EnableVideoPlaybackTranscoding` boolean - `EnablePlaybackRemuxing` boolean - `ForceRemoteSourceTranscoding` boolean - `EnableContentDeletion` boolean - `EnableContentDeletionFromFolders` string[], nullable - `EnableContentDownloading` boolean - `EnableSyncTranscoding` boolean — Gets or sets a value indicating whether [enable synchronize]. - `EnableMediaConversion` boolean - `EnabledDevices` string[], nullable - `EnableAllDevices` boolean - `EnabledChannels` string[], nullable - `EnableAllChannels` boolean - `EnabledFolders` string[], nullable - `EnableAllFolders` boolean - `InvalidLoginAttemptCount` integer - `LoginAttemptsBeforeLockout` integer - `MaxActiveSessions` integer - `EnablePublicSharing` boolean - `BlockedMediaFolders` string[], nullable - `BlockedChannels` string[], nullable - `RemoteClientBitrateLimit` integer - `AuthenticationProviderId` string, nullable - `PasswordResetProviderId` string, nullable - `SyncPlayAccess` 'CreateAndJoinGroups' | 'JoinGroups' | 'None' — Enum SyncPlayUserAccessType. - `PrimaryImageAspectRatio` number, double, nullable — Gets or sets the primary image aspect ratio. - `SessionInfo` SessionInfo — Class SessionInfo. - `PlayState` PlayerStateInfo - `PositionTicks` integer, nullable — Gets or sets the now playing position ticks. - `CanSeek` boolean — Gets or sets a value indicating whether this instance can seek. - `IsPaused` boolean — Gets or sets a value indicating whether this instance is paused. - `IsMuted` boolean — Gets or sets a value indicating whether this instance is muted. - `VolumeLevel` integer, nullable — Gets or sets the volume level. - `AudioStreamIndex` integer, nullable — Gets or sets the index of the now playing audio stream. - `SubtitleStreamIndex` integer, nullable — Gets or sets the index of the now playing subtitle stream. - `MediaSourceId` string, nullable — Gets or sets the now playing media version identifier. - `PlayMethod` 'Transcode' | 'DirectStream' | 'DirectPlay' - `RepeatMode` 'RepeatNone' | 'RepeatAll' | 'RepeatOne' - `AdditionalUsers` SessionUserInfo[], nullable - `UserId` string, uuid — Gets or sets the user identifier. - `UserName` string, nullable — Gets or sets the name of the user. - `Capabilities` ClientCapabilities - `PlayableMediaTypes` string[], nullable - `SupportedCommands` GeneralCommandType[], nullable - `SupportsMediaControl` boolean - `SupportsContentUploading` boolean - `MessageCallbackUrl` string, nullable - `SupportsPersistentIdentifier` boolean - `SupportsSync` boolean - `DeviceProfile` DeviceProfile — Defines the MediaBrowser.Model.Dlna.DeviceProfile. - `Name` string, nullable — Gets or sets the Name. - `Id` string, nullable — Gets or sets the Id. - `Identification` DeviceIdentification - `FriendlyName` string, nullable — Gets or sets the name of the friendly. - `ModelNumber` string, nullable — Gets or sets the model number. - `SerialNumber` string, nullable — Gets or sets the serial number. - `ModelName` string, nullable — Gets or sets the name of the model. - `ModelDescription` string, nullable — Gets or sets the model description. - `ModelUrl` string, nullable — Gets or sets the model URL. - `Manufacturer` string, nullable — Gets or sets the manufacturer. - `ManufacturerUrl` string, nullable — Gets or sets the manufacturer URL. - `Headers` HttpHeaderInfo[], nullable — Gets or sets the headers. - `Name` string, nullable - `Value` string, nullable - `Match` 'Equals' | 'Regex' | 'Substring' - `FriendlyName` string, nullable — Gets or sets the FriendlyName. - `Manufacturer` string, nullable — Gets or sets the Manufacturer. - `ManufacturerUrl` string, nullable — Gets or sets the ManufacturerUrl. - `ModelName` string, nullable — Gets or sets the ModelName. - `ModelDescription` string, nullable — Gets or sets the ModelDescription. - `ModelNumber` string, nullable — Gets or sets the ModelNumber. - `ModelUrl` string, nullable — Gets or sets the ModelUrl. - `SerialNumber` string, nullable — Gets or sets the SerialNumber. - `EnableAlbumArtInDidl` boolean — Gets or sets a value indicating whether EnableAlbumArtInDidl. - `EnableSingleAlbumArtLimit` boolean — Gets or sets a value indicating whether EnableSingleAlbumArtLimit. - `EnableSingleSubtitleLimit` boolean — Gets or sets a value indicating whether EnableSingleSubtitleLimit. - `SupportedMediaTypes` string, nullable — Gets or sets the SupportedMediaTypes. - `UserId` string, nullable — Gets or sets the UserId. - `AlbumArtPn` string, nullable — Gets or sets the AlbumArtPn. - `MaxAlbumArtWidth` integer — Gets or sets the MaxAlbumArtWidth. - `MaxAlbumArtHeight` integer — Gets or sets the MaxAlbumArtHeight. - `MaxIconWidth` integer, nullable — Gets or sets the MaxIconWidth. - `MaxIconHeight` integer, nullable — Gets or sets the MaxIconHeight. - `MaxStreamingBitrate` integer, nullable — Gets or sets the MaxStreamingBitrate. - `MaxStaticBitrate` integer, nullable — Gets or sets the MaxStaticBitrate. - `MusicStreamingTranscodingBitrate` integer, nullable — Gets or sets the MusicStreamingTranscodingBitrate. - `MaxStaticMusicBitrate` integer, nullable — Gets or sets the MaxStaticMusicBitrate. - `SonyAggregationFlags` string, nullable — Gets or sets the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace. - `ProtocolInfo` string, nullable — Gets or sets the ProtocolInfo. - `TimelineOffsetSeconds` integer — Gets or sets the TimelineOffsetSeconds. - `RequiresPlainVideoItems` boolean — Gets or sets a value indicating whether RequiresPlainVideoItems. - `RequiresPlainFolders` boolean — Gets or sets a value indicating whether RequiresPlainFolders. - `EnableMSMediaReceiverRegistrar` boolean — Gets or sets a value indicating whether EnableMSMediaReceiverRegistrar. - `IgnoreTranscodeByteRangeRequests` boolean — Gets or sets a value indicating whether IgnoreTranscodeByteRangeRequests. - `XmlRootAttributes` XmlAttribute[], nullable — Gets or sets the XmlRootAttributes. - `Name` string, nullable — Gets or sets the name of the attribute. - `Value` string, nullable — Gets or sets the value of the attribute. - `DirectPlayProfiles` DirectPlayProfile[], nullable — Gets or sets the direct play profiles. - `Container` string, nullable - `AudioCodec` string, nullable - `VideoCodec` string, nullable - `Type` 'Audio' | 'Video' | 'Photo' - `TranscodingProfiles` TranscodingProfile[], nullable — Gets or sets the transcoding profiles. - `Container` string, nullable - `Type` 'Audio' | 'Video' | 'Photo' - `VideoCodec` string, nullable - `AudioCodec` string, nullable - `Protocol` string, nullable - `EstimateContentLength` boolean - `EnableMpegtsM2TsMode` boolean - `TranscodeSeekInfo` 'Auto' | 'Bytes' - `CopyTimestamps` boolean - `Context` 'Streaming' | 'Static' - `EnableSubtitlesInManifest` boolean - `MaxAudioChannels` string, nullable - `MinSegments` integer - `SegmentLength` integer - `BreakOnNonKeyFrames` boolean - `ContainerProfiles` ContainerProfile[], nullable — Gets or sets the ContainerProfiles. - `Type` 'Audio' | 'Video' | 'Photo' - `Conditions` ProfileCondition[], nullable - `Condition` 'Equals' | 'NotEquals' | 'LessThanEqual' | 'GreaterThanEqual' | 'EqualsAny' - `Property` 'AudioChannels' | 'AudioBitrate' | 'AudioProfile' | 'Width' | 'Height' | 'Has64BitOffsets' | 'PacketLength' | 'VideoBitDepth' | 'VideoBitrate' | 'VideoFramerate' | 'VideoLevel' | 'VideoProfile' | 'VideoTimestamp' | 'IsAnamorphic' | 'RefFrames' | 'NumAudioStreams' | 'NumVideoStreams' | 'IsSecondaryAudio' | 'VideoCodecTag' | 'IsAvc' | 'IsInterlaced' | 'AudioSampleRate' | 'AudioBitDepth' - `Value` string, nullable - `IsRequired` boolean - `Container` string, nullable - `CodecProfiles` CodecProfile[], nullable — Gets or sets the CodecProfiles. - `Type` 'Video' | 'VideoAudio' | 'Audio' - `Conditions` ProfileCondition[], nullable - `Condition` 'Equals' | 'NotEquals' | 'LessThanEqual' | 'GreaterThanEqual' | 'EqualsAny' - `Property` 'AudioChannels' | 'AudioBitrate' | 'AudioProfile' | 'Width' | 'Height' | 'Has64BitOffsets' | 'PacketLength' | 'VideoBitDepth' | 'VideoBitrate' | 'VideoFramerate' | 'VideoLevel' | 'VideoProfile' | 'VideoTimestamp' | 'IsAnamorphic' | 'RefFrames' | 'NumAudioStreams' | 'NumVideoStreams' | 'IsSecondaryAudio' | 'VideoCodecTag' | 'IsAvc' | 'IsInterlaced' | 'AudioSampleRate' | 'AudioBitDepth' - `Value` string, nullable - `IsRequired` boolean - `ApplyConditions` ProfileCondition[], nullable - `Condition` 'Equals' | 'NotEquals' | 'LessThanEqual' | 'GreaterThanEqual' | 'EqualsAny' - `Property` 'AudioChannels' | 'AudioBitrate' | 'AudioProfile' | 'Width' | 'Height' | 'Has64BitOffsets' | 'PacketLength' | 'VideoBitDepth' | 'VideoBitrate' | 'VideoFramerate' | 'VideoLevel' | 'VideoProfile' | 'VideoTimestamp' | 'IsAnamorphic' | 'RefFrames' | 'NumAudioStreams' | 'NumVideoStreams' | 'IsSecondaryAudio' | 'VideoCodecTag' | 'IsAvc' | 'IsInterlaced' | 'AudioSampleRate' | 'AudioBitDepth' - `Value` string, nullable - `IsRequired` boolean - `Codec` string, nullable - `Container` string, nullable - `ResponseProfiles` ResponseProfile[], nullable — Gets or sets the ResponseProfiles. - `Container` string, nullable - `AudioCodec` string, nullable - `VideoCodec` string, nullable - `Type` 'Audio' | 'Video' | 'Photo' - `OrgPn` string, nullable - `MimeType` string, nullable - `Conditions` ProfileCondition[], nullable - `Condition` 'Equals' | 'NotEquals' | 'LessThanEqual' | 'GreaterThanEqual' | 'EqualsAny' - `Property` 'AudioChannels' | 'AudioBitrate' | 'AudioProfile' | 'Width' | 'Height' | 'Has64BitOffsets' | 'PacketLength' | 'VideoBitDepth' | 'VideoBitrate' | 'VideoFramerate' | 'VideoLevel' | 'VideoProfile' | 'VideoTimestamp' | 'IsAnamorphic' | 'RefFrames' | 'NumAudioStreams' | 'NumVideoStreams' | 'IsSecondaryAudio' | 'VideoCodecTag' | 'IsAvc' | 'IsInterlaced' | 'AudioSampleRate' | 'AudioBitDepth' - `Value` string, nullable - `IsRequired` boolean - `SubtitleProfiles` SubtitleProfile[], nullable — Gets or sets the SubtitleProfiles. - `Format` string, nullable - `Method` 'Encode' | 'Embed' | 'External' | 'Hls' - `DidlMode` string, nullable - `Language` string, nullable - `Container` string, nullable - `AppStoreUrl` string, nullable - `IconUrl` string, nullable - `RemoteEndPoint` string, nullable — Gets or sets the remote end point. - `PlayableMediaTypes` string[], nullable — Gets or sets the playable media types. - `Id` string, nullable — Gets or sets the id. - `UserId` string, uuid — Gets or sets the user id. - `UserName` string, nullable — Gets or sets the username. - `Client` string, nullable — Gets or sets the type of the client. - `LastActivityDate` string, date-time — Gets or sets the last activity date. - `LastPlaybackCheckIn` string, date-time — Gets or sets the last playback check in. - `DeviceName` string, nullable — Gets or sets the name of the device. - `DeviceType` string, nullable — Gets or sets the type of the device. - `NowPlayingItem` BaseItemDto — 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. - `Name` string, nullable — Gets or sets the name. - `OriginalTitle` string, nullable - `ServerId` string, nullable — Gets or sets the server identifier. - `Id` string, uuid — Gets or sets the id. - `Etag` string, nullable — Gets or sets the etag. - `SourceType` string, nullable — Gets or sets the type of the source. - `PlaylistItemId` string, nullable — Gets or sets the playlist item identifier. - `DateCreated` string, date-time, nullable — Gets or sets the date created. - `DateLastMediaAdded` string, date-time, nullable - `ExtraType` string, nullable - `AirsBeforeSeasonNumber` integer, nullable - `AirsAfterSeasonNumber` integer, nullable - `AirsBeforeEpisodeNumber` integer, nullable - `CanDelete` boolean, nullable - `CanDownload` boolean, nullable - `HasSubtitles` boolean, nullable - `PreferredMetadataLanguage` string, nullable - `PreferredMetadataCountryCode` string, nullable - `SupportsSync` boolean, nullable — Gets or sets a value indicating whether [supports synchronize]. - `Container` string, nullable - `SortName` string, nullable — Gets or sets the name of the sort. - `ForcedSortName` string, nullable - `Video3DFormat` 'HalfSideBySide' | 'FullSideBySide' | 'FullTopAndBottom' | 'HalfTopAndBottom' | 'MVC' - `PremiereDate` string, date-time, nullable — Gets or sets the premiere date. - `ExternalUrls` ExternalUrl[], nullable — Gets or sets the external urls. - `Name` string, nullable — Gets or sets the name. - `Url` string, nullable — Gets or sets the type of the item. - `MediaSources` MediaSourceInfo[], nullable — Gets or sets the media versions. - `Protocol` 'File' | 'Http' | 'Rtmp' | 'Rtsp' | 'Udp' | 'Rtp' | 'Ftp' - `Id` string, nullable - `Path` string, nullable - `EncoderPath` string, nullable - `EncoderProtocol` 'File' | 'Http' | 'Rtmp' | 'Rtsp' | 'Udp' | 'Rtp' | 'Ftp' - `Type` 'Default' | 'Grouping' | 'Placeholder' - `Container` string, nullable - `Size` integer, nullable - `Name` string, nullable - `IsRemote` boolean — Differentiate internet url vs local network. - `ETag` string, nullable - `RunTimeTicks` integer, nullable - `ReadAtNativeFramerate` boolean - `IgnoreDts` boolean - `IgnoreIndex` boolean - `GenPtsInput` boolean - `SupportsTranscoding` boolean - `SupportsDirectStream` boolean - `SupportsDirectPlay` boolean - `IsInfiniteStream` boolean - `RequiresOpening` boolean - `OpenToken` string, nullable - `RequiresClosing` boolean - `LiveStreamId` string, nullable - `BufferMs` integer, nullable - `RequiresLooping` boolean - `SupportsProbing` boolean - `VideoType` 'VideoFile' | 'Iso' | 'Dvd' | 'BluRay' — Enum VideoType. - `IsoType` 'Dvd' | 'BluRay' — Enum IsoType. - `Video3DFormat` 'HalfSideBySide' | 'FullSideBySide' | 'FullTopAndBottom' | 'HalfTopAndBottom' | 'MVC' - `MediaStreams` MediaStream[], nullable - `Codec` string, nullable — Gets or sets the codec. - `CodecTag` string, nullable — Gets or sets the codec tag. - `Language` string, nullable — Gets or sets the language. - `ColorRange` string, nullable — Gets or sets the color range. - `ColorSpace` string, nullable — Gets or sets the color space. - `ColorTransfer` string, nullable — Gets or sets the color transfer. - `ColorPrimaries` string, nullable — Gets or sets the color primaries. - `Comment` string, nullable — Gets or sets the comment. - `TimeBase` string, nullable — Gets or sets the time base. - `CodecTimeBase` string, nullable — Gets or sets the codec time base. - `Title` string, nullable — Gets or sets the title. - `VideoRange` string, nullable — Gets or sets the video range. - `localizedUndefined` string, nullable - `localizedDefault` string, nullable - `localizedForced` string, nullable - `DisplayTitle` string, nullable - `NalLengthSize` string, nullable - `IsInterlaced` boolean — Gets or sets a value indicating whether this instance is interlaced. - `IsAVC` boolean, nullable - `ChannelLayout` string, nullable — Gets or sets the channel layout. - `BitRate` integer, nullable — Gets or sets the bit rate. - `BitDepth` integer, nullable — Gets or sets the bit depth. - `RefFrames` integer, nullable — Gets or sets the reference frames. - `PacketLength` integer, nullable — Gets or sets the length of the packet. - `Channels` integer, nullable — Gets or sets the channels. - `SampleRate` integer, nullable — Gets or sets the sample rate. - `IsDefault` boolean — Gets or sets a value indicating whether this instance is default. - `IsForced` boolean — Gets or sets a value indicating whether this instance is forced. - `Height` integer, nullable — Gets or sets the height. - `Width` integer, nullable — Gets or sets the width. - `AverageFrameRate` number, float, nullable — Gets or sets the average frame rate. - `RealFrameRate` number, float, nullable — Gets or sets the real frame rate. - `Profile` string, nullable — Gets or sets the profile. - `Type` 'Audio' | 'Video' | 'Subtitle' | 'EmbeddedImage' — Enum MediaStreamType. - `AspectRatio` string, nullable — Gets or sets the aspect ratio. - `Index` integer — Gets or sets the index. - `Score` integer, nullable — Gets or sets the score. - `IsExternal` boolean — Gets or sets a value indicating whether this instance is external. - `DeliveryMethod` 'Encode' | 'Embed' | 'External' | 'Hls' - `DeliveryUrl` string, nullable — Gets or sets the delivery URL. - `IsExternalUrl` boolean, nullable — Gets or sets a value indicating whether this instance is external URL. - `IsTextSubtitleStream` boolean - `SupportsExternalStream` boolean — Gets or sets a value indicating whether [supports external stream]. - `Path` string, nullable — Gets or sets the filename. - `PixelFormat` string, nullable — Gets or sets the pixel format. - `Level` number, double, nullable — Gets or sets the level. - `IsAnamorphic` boolean, nullable — Gets a value indicating whether this instance is anamorphic. - `MediaAttachments` MediaAttachment[], nullable - `Codec` string, nullable — Gets or sets the codec. - `CodecTag` string, nullable — Gets or sets the codec tag. - `Comment` string, nullable — Gets or sets the comment. - `Index` integer — Gets or sets the index. - `FileName` string, nullable — Gets or sets the filename. - `MimeType` string, nullable — Gets or sets the MIME type. - `DeliveryUrl` string, nullable — Gets or sets the delivery URL. - `Formats` string[], nullable - `Bitrate` integer, nullable - `Timestamp` 'None' | 'Zero' | 'Valid' - `RequiredHttpHeaders` object, nullable - `TranscodingUrl` string, nullable - `TranscodingSubProtocol` string, nullable - `TranscodingContainer` string, nullable - `AnalyzeDurationMs` integer, nullable - `DefaultAudioStreamIndex` integer, nullable - `DefaultSubtitleStreamIndex` integer, nullable - `CriticRating` number, float, nullable — Gets or sets the critic rating. - `ProductionLocations` string[], nullable - `Path` string, nullable — Gets or sets the path. - `EnableMediaSourceDisplay` boolean, nullable - `OfficialRating` string, nullable — Gets or sets the official rating. - `CustomRating` string, nullable — Gets or sets the custom rating. - `ChannelId` string, uuid, nullable — Gets or sets the channel identifier. - `ChannelName` string, nullable - `Overview` string, nullable — Gets or sets the overview. - `Taglines` string[], nullable — Gets or sets the taglines. - `Genres` string[], nullable — Gets or sets the genres. - `CommunityRating` number, float, nullable — Gets or sets the community rating. - `CumulativeRunTimeTicks` integer, nullable — Gets or sets the cumulative run time ticks. - `RunTimeTicks` integer, nullable — Gets or sets the run time ticks. - `PlayAccess` 'Full' | 'None' - `AspectRatio` string, nullable — Gets or sets the aspect ratio. - `ProductionYear` integer, nullable — Gets or sets the production year. - `IsPlaceHolder` boolean, nullable — Gets or sets a value indicating whether this instance is place holder. - `Number` string, nullable — Gets or sets the number. - `ChannelNumber` string, nullable - `IndexNumber` integer, nullable — Gets or sets the index number. - `IndexNumberEnd` integer, nullable — Gets or sets the index number end. - `ParentIndexNumber` integer, nullable — Gets or sets the parent index number. - `RemoteTrailers` MediaUrl[], nullable — Gets or sets the trailer urls. - `Url` string, nullable - `Name` string, nullable - `ProviderIds` object, nullable — Gets or sets the provider ids. - `IsHD` boolean, nullable — Gets or sets a value indicating whether this instance is HD. - `IsFolder` boolean, nullable — Gets or sets a value indicating whether this instance is folder. - `ParentId` string, uuid, nullable — Gets or sets the parent id. - `Type` string, nullable — Gets or sets the type. - `People` BaseItemPerson[], nullable — Gets or sets the people. - `Name` string, nullable — Gets or sets the name. - `Id` string, nullable — Gets or sets the identifier. - `Role` string, nullable — Gets or sets the role. - `Type` string, nullable — Gets or sets the type. - `PrimaryImageTag` string, nullable — Gets or sets the primary image tag. - `ImageBlurHashes` object, nullable — Gets or sets the primary image blurhash. - `Primary` object - `Art` object - `Backdrop` object - `Banner` object - `Logo` object - `Thumb` object - `Disc` object - `Box` object - `Screenshot` object - `Menu` object - `Chapter` object - `BoxRear` object - `Profile` object - `Studios` NameGuidPair[], nullable — Gets or sets the studios. - `Name` string, nullable - `Id` string, uuid - `GenreItems` NameGuidPair[], nullable - `Name` string, nullable - `Id` string, uuid - `ParentLogoItemId` string, nullable — If the item does not have a logo, this will hold the Id of the Parent that has one. - `ParentBackdropItemId` string, nullable — If the item does not have any backdrops, this will hold the Id of the Parent that has one. - `ParentBackdropImageTags` string[], nullable — Gets or sets the parent backdrop image tags. - `LocalTrailerCount` integer, nullable — Gets or sets the local trailer count. - `UserData` UserItemDataDto — Class UserItemDataDto. - `Rating` number, double, nullable — Gets or sets the rating. - `PlayedPercentage` number, double, nullable — Gets or sets the played percentage. - `UnplayedItemCount` integer, nullable — Gets or sets the unplayed item count. - `PlaybackPositionTicks` integer — Gets or sets the playback position ticks. - `PlayCount` integer — Gets or sets the play count. - `IsFavorite` boolean — Gets or sets a value indicating whether this instance is favorite. - `Likes` boolean, nullable — Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is likes. - `LastPlayedDate` string, date-time, nullable — Gets or sets the last played date. - `Played` boolean — Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is played. - `Key` string, nullable — Gets or sets the key. - `ItemId` string, nullable — Gets or sets the item identifier. - `RecursiveItemCount` integer, nullable — Gets or sets the recursive item count. - `ChildCount` integer, nullable — Gets or sets the child count. - `SeriesName` string, nullable — Gets or sets the name of the series. - `SeriesId` string, uuid, nullable — Gets or sets the series id. - `SeasonId` string, uuid, nullable — Gets or sets the season identifier. - `SpecialFeatureCount` integer, nullable — Gets or sets the special feature count. - `DisplayPreferencesId` string, nullable — Gets or sets the display preferences id. - `Status` string, nullable — Gets or sets the status. - `AirTime` string, nullable — Gets or sets the air time. - `AirDays` DayOfWeek[], nullable — Gets or sets the air days. - `Tags` string[], nullable — Gets or sets the tags. - `PrimaryImageAspectRatio` number, double, nullable — Gets or sets the primary image aspect ratio, after image enhancements. - `Artists` string[], nullable — Gets or sets the artists. - `ArtistItems` NameGuidPair[], nullable — Gets or sets the artist items. - `Name` string, nullable - `Id` string, uuid - `Album` string, nullable — Gets or sets the album. - `CollectionType` string, nullable — Gets or sets the type of the collection. - `DisplayOrder` string, nullable — Gets or sets the display order. - `AlbumId` string, uuid, nullable — Gets or sets the album id. - `AlbumPrimaryImageTag` string, nullable — Gets or sets the album image tag. - `SeriesPrimaryImageTag` string, nullable — Gets or sets the series primary image tag. - `AlbumArtist` string, nullable — Gets or sets the album artist. - `AlbumArtists` NameGuidPair[], nullable — Gets or sets the album artists. - `Name` string, nullable - `Id` string, uuid - `SeasonName` string, nullable — Gets or sets the name of the season. - `MediaStreams` MediaStream[], nullable — Gets or sets the media streams. - `Codec` string, nullable — Gets or sets the codec. - `CodecTag` string, nullable — Gets or sets the codec tag. - `Language` string, nullable — Gets or sets the language. - `ColorRange` string, nullable — Gets or sets the color range. - `ColorSpace` string, nullable — Gets or sets the color space. - `ColorTransfer` string, nullable — Gets or sets the color transfer. - `ColorPrimaries` string, nullable — Gets or sets the color primaries. - `Comment` string, nullable — Gets or sets the comment. - `TimeBase` string, nullable — Gets or sets the time base. - `CodecTimeBase` string, nullable — Gets or sets the codec time base. - `Title` string, nullable — Gets or sets the title. - `VideoRange` string, nullable — Gets or sets the video range. - `localizedUndefined` string, nullable - `localizedDefault` string, nullable - `localizedForced` string, nullable - `DisplayTitle` string, nullable - `NalLengthSize` string, nullable - `IsInterlaced` boolean — Gets or sets a value indicating whether this instance is interlaced. - `IsAVC` boolean, nullable - `ChannelLayout` string, nullable — Gets or sets the channel layout. - `BitRate` integer, nullable — Gets or sets the bit rate. - `BitDepth` integer, nullable — Gets or sets the bit depth. - `RefFrames` integer, nullable — Gets or sets the reference frames. - `PacketLength` integer, nullable — Gets or sets the length of the packet. - `Channels` integer, nullable — Gets or sets the channels. - `SampleRate` integer, nullable — Gets or sets the sample rate. - `IsDefault` boolean — Gets or sets a value indicating whether this instance is default. - `IsForced` boolean — Gets or sets a value indicating whether this instance is forced. - `Height` integer, nullable — Gets or sets the height. - `Width` integer, nullable — Gets or sets the width. - `AverageFrameRate` number, float, nullable — Gets or sets the average frame rate. - `RealFrameRate` number, float, nullable — Gets or sets the real frame rate. - `Profile` string, nullable — Gets or sets the profile. - `Type` 'Audio' | 'Video' | 'Subtitle' | 'EmbeddedImage' — Enum MediaStreamType. - `AspectRatio` string, nullable — Gets or sets the aspect ratio. - `Index` integer — Gets or sets the index. - `Score` integer, nullable — Gets or sets the score. - `IsExternal` boolean — Gets or sets a value indicating whether this instance is external. - `DeliveryMethod` 'Encode' | 'Embed' | 'External' | 'Hls' - `DeliveryUrl` string, nullable — Gets or sets the delivery URL. - `IsExternalUrl` boolean, nullable — Gets or sets a value indicating whether this instance is external URL. - `IsTextSubtitleStream` boolean - `SupportsExternalStream` boolean — Gets or sets a value indicating whether [supports external stream]. - `Path` string, nullable — Gets or sets the filename. - `PixelFormat` string, nullable — Gets or sets the pixel format. - `Level` number, double, nullable — Gets or sets the level. - `IsAnamorphic` boolean, nullable — Gets a value indicating whether this instance is anamorphic. - `VideoType` 'VideoFile' | 'Iso' | 'Dvd' | 'BluRay' — Enum VideoType. - `PartCount` integer, nullable — Gets or sets the part count. - `MediaSourceCount` integer, nullable - `ImageTags` object, nullable — Gets or sets the image tags. - `BackdropImageTags` string[], nullable — Gets or sets the backdrop image tags. - `ScreenshotImageTags` string[], nullable — Gets or sets the screenshot image tags. - `ParentLogoImageTag` string, nullable — Gets or sets the parent logo image tag. - `ParentArtItemId` string, nullable — If the item does not have a art, this will hold the Id of the Parent that has one. - `ParentArtImageTag` string, nullable — Gets or sets the parent art image tag. - `SeriesThumbImageTag` string, nullable — Gets or sets the series thumb image tag. - `ImageBlurHashes` object, nullable — Gets or sets the blurhashes for the image tags. Maps image type to dictionary mapping image tag to blurhash value. - `Primary` object - `Art` object - `Backdrop` object - `Banner` object - `Logo` object - `Thumb` object - `Disc` object - `Box` object - `Screenshot` object - `Menu` object - `Chapter` object - `BoxRear` object - `Profile` object - `SeriesStudio` string, nullable — Gets or sets the series studio. - `ParentThumbItemId` string, nullable — Gets or sets the parent thumb item id. - `ParentThumbImageTag` string, nullable — Gets or sets the parent thumb image tag. - `ParentPrimaryImageItemId` string, nullable — Gets or sets the parent primary image item identifier. - `ParentPrimaryImageTag` string, nullable — Gets or sets the parent primary image tag. - `Chapters` ChapterInfo[], nullable — Gets or sets the chapters. - `StartPositionTicks` integer — Gets or sets the start position ticks. - `Name` string, nullable — Gets or sets the name. - `ImagePath` string, nullable — Gets or sets the image path. - `ImageDateModified` string, date-time - `ImageTag` string, nullable - `LocationType` 'FileSystem' | 'Remote' | 'Virtual' | 'Offline' — Enum LocationType. - `IsoType` 'Dvd' | 'BluRay' — Enum IsoType. - `MediaType` string, nullable — Gets or sets the type of the media. - `EndDate` string, date-time, nullable — Gets or sets the end date. - `LockedFields` MetadataField[], nullable — Gets or sets the locked fields. - `TrailerCount` integer, nullable — Gets or sets the trailer count. - `MovieCount` integer, nullable — Gets or sets the movie count. - `SeriesCount` integer, nullable — Gets or sets the series count. - `ProgramCount` integer, nullable - `EpisodeCount` integer, nullable — Gets or sets the episode count. - `SongCount` integer, nullable — Gets or sets the song count. - `AlbumCount` integer, nullable — Gets or sets the album count. - `ArtistCount` integer, nullable - `MusicVideoCount` integer, nullable — Gets or sets the music video count. - `LockData` boolean, nullable — Gets or sets a value indicating whether [enable internet providers]. - `Width` integer, nullable - `Height` integer, nullable - `CameraMake` string, nullable - `CameraModel` string, nullable - `Software` string, nullable - `ExposureTime` number, double, nullable - `FocalLength` number, double, nullable - `ImageOrientation` 'TopLeft' | 'TopRight' | 'BottomRight' | 'BottomLeft' | 'LeftTop' | 'RightTop' | 'RightBottom' | 'LeftBottom' - `Aperture` number, double, nullable - `ShutterSpeed` number, double, nullable - `Latitude` number, double, nullable - `Longitude` number, double, nullable - `Altitude` number, double, nullable - `IsoSpeedRating` integer, nullable - `SeriesTimerId` string, nullable — Gets or sets the series timer identifier. - `ProgramId` string, nullable — Gets or sets the program identifier. - `ChannelPrimaryImageTag` string, nullable — Gets or sets the channel primary image tag. - `StartDate` string, date-time, nullable — The start date of the recording, in UTC. - `CompletionPercentage` number, double, nullable — Gets or sets the completion percentage. - `IsRepeat` boolean, nullable — Gets or sets a value indicating whether this instance is repeat. - `EpisodeTitle` string, nullable — Gets or sets the episode title. - `ChannelType` 'TV' | 'Radio' — Enum ChannelType. - `Audio` 'Mono' | 'Stereo' | 'Dolby' | 'DolbyDigital' | 'Thx' | 'Atmos' - `IsMovie` boolean, nullable — Gets or sets a value indicating whether this instance is movie. - `IsSports` boolean, nullable — Gets or sets a value indicating whether this instance is sports. - `IsSeries` boolean, nullable — Gets or sets a value indicating whether this instance is series. - `IsLive` boolean, nullable — Gets or sets a value indicating whether this instance is live. - `IsNews` boolean, nullable — Gets or sets a value indicating whether this instance is news. - `IsKids` boolean, nullable — Gets or sets a value indicating whether this instance is kids. - `IsPremiere` boolean, nullable — Gets or sets a value indicating whether this instance is premiere. - `TimerId` string, nullable — Gets or sets the timer identifier. - `CurrentProgram` BaseItemDto — recursive - `FullNowPlayingItem` BaseItem — Class BaseItem. - `Size` integer, nullable - `Container` string, nullable - `DateLastSaved` string, date-time - `RemoteTrailers` MediaUrl[], nullable — Gets or sets the remote trailers. - `Url` string, nullable - `Name` string, nullable - `IsHD` boolean - `IsShortcut` boolean - `ShortcutPath` string, nullable - `Width` integer - `Height` integer - `ExtraIds` string[], nullable - `SupportsExternalTransfer` boolean - `NowViewingItem` BaseItemDto — 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. - `Name` string, nullable — Gets or sets the name. - `OriginalTitle` string, nullable - `ServerId` string, nullable — Gets or sets the server identifier. - `Id` string, uuid — Gets or sets the id. - `Etag` string, nullable — Gets or sets the etag. - `SourceType` string, nullable — Gets or sets the type of the source. - `PlaylistItemId` string, nullable — Gets or sets the playlist item identifier. - `DateCreated` string, date-time, nullable — Gets or sets the date created. - `DateLastMediaAdded` string, date-time, nullable - `ExtraType` string, nullable - `AirsBeforeSeasonNumber` integer, nullable - `AirsAfterSeasonNumber` integer, nullable - `AirsBeforeEpisodeNumber` integer, nullable - `CanDelete` boolean, nullable - `CanDownload` boolean, nullable - `HasSubtitles` boolean, nullable - `PreferredMetadataLanguage` string, nullable - `PreferredMetadataCountryCode` string, nullable - `SupportsSync` boolean, nullable — Gets or sets a value indicating whether [supports synchronize]. - `Container` string, nullable - `SortName` string, nullable — Gets or sets the name of the sort. - `ForcedSortName` string, nullable - `Video3DFormat` 'HalfSideBySide' | 'FullSideBySide' | 'FullTopAndBottom' | 'HalfTopAndBottom' | 'MVC' - `PremiereDate` string, date-time, nullable — Gets or sets the premiere date. - `ExternalUrls` ExternalUrl[], nullable — Gets or sets the external urls. - `Name` string, nullable — Gets or sets the name. - `Url` string, nullable — Gets or sets the type of the item. - `MediaSources` MediaSourceInfo[], nullable — Gets or sets the media versions. - `Protocol` 'File' | 'Http' | 'Rtmp' | 'Rtsp' | 'Udp' | 'Rtp' | 'Ftp' - `Id` string, nullable - `Path` string, nullable - `EncoderPath` string, nullable - `EncoderProtocol` 'File' | 'Http' | 'Rtmp' | 'Rtsp' | 'Udp' | 'Rtp' | 'Ftp' - `Type` 'Default' | 'Grouping' | 'Placeholder' - `Container` string, nullable - `Size` integer, nullable - `Name` string, nullable - `IsRemote` boolean — Differentiate internet url vs local network. - `ETag` string, nullable - `RunTimeTicks` integer, nullable - `ReadAtNativeFramerate` boolean - `IgnoreDts` boolean - `IgnoreIndex` boolean - `GenPtsInput` boolean - `SupportsTranscoding` boolean - `SupportsDirectStream` boolean - `SupportsDirectPlay` boolean - `IsInfiniteStream` boolean - `RequiresOpening` boolean - `OpenToken` string, nullable - `RequiresClosing` boolean - `LiveStreamId` string, nullable - `BufferMs` integer, nullable - `RequiresLooping` boolean - `SupportsProbing` boolean - `VideoType` 'VideoFile' | 'Iso' | 'Dvd' | 'BluRay' — Enum VideoType. - `IsoType` 'Dvd' | 'BluRay' — Enum IsoType. - `Video3DFormat` 'HalfSideBySide' | 'FullSideBySide' | 'FullTopAndBottom' | 'HalfTopAndBottom' | 'MVC' - `MediaStreams` MediaStream[], nullable - `Codec` string, nullable — Gets or sets the codec. - `CodecTag` string, nullable — Gets or sets the codec tag. - `Language` string, nullable — Gets or sets the language. - `ColorRange` string, nullable — Gets or sets the color range. - `ColorSpace` string, nullable — Gets or sets the color space. - `ColorTransfer` string, nullable — Gets or sets the color transfer. - `ColorPrimaries` string, nullable — Gets or sets the color primaries. - `Comment` string, nullable — Gets or sets the comment. - `TimeBase` string, nullable — Gets or sets the time base. - `CodecTimeBase` string, nullable — Gets or sets the codec time base. - `Title` string, nullable — Gets or sets the title. - `VideoRange` string, nullable — Gets or sets the video range. - `localizedUndefined` string, nullable - `localizedDefault` string, nullable - `localizedForced` string, nullable - `DisplayTitle` string, nullable - `NalLengthSize` string, nullable - `IsInterlaced` boolean — Gets or sets a value indicating whether this instance is interlaced. - `IsAVC` boolean, nullable - `ChannelLayout` string, nullable — Gets or sets the channel layout. - `BitRate` integer, nullable — Gets or sets the bit rate. - `BitDepth` integer, nullable — Gets or sets the bit depth. - `RefFrames` integer, nullable — Gets or sets the reference frames. - `PacketLength` integer, nullable — Gets or sets the length of the packet. - `Channels` integer, nullable — Gets or sets the channels. - `SampleRate` integer, nullable — Gets or sets the sample rate. - `IsDefault` boolean — Gets or sets a value indicating whether this instance is default. - `IsForced` boolean — Gets or sets a value indicating whether this instance is forced. - `Height` integer, nullable — Gets or sets the height. - `Width` integer, nullable — Gets or sets the width. - `AverageFrameRate` number, float, nullable — Gets or sets the average frame rate. - `RealFrameRate` number, float, nullable — Gets or sets the real frame rate. - `Profile` string, nullable — Gets or sets the profile. - `Type` 'Audio' | 'Video' | 'Subtitle' | 'EmbeddedImage' — Enum MediaStreamType. - `AspectRatio` string, nullable — Gets or sets the aspect ratio. - `Index` integer — Gets or sets the index. - `Score` integer, nullable — Gets or sets the score. - `IsExternal` boolean — Gets or sets a value indicating whether this instance is external. - `DeliveryMethod` 'Encode' | 'Embed' | 'External' | 'Hls' - `DeliveryUrl` string, nullable — Gets or sets the delivery URL. - `IsExternalUrl` boolean, nullable — Gets or sets a value indicating whether this instance is external URL. - `IsTextSubtitleStream` boolean - `SupportsExternalStream` boolean — Gets or sets a value indicating whether [supports external stream]. - `Path` string, nullable — Gets or sets the filename. - `PixelFormat` string, nullable — Gets or sets the pixel format. - `Level` number, double, nullable — Gets or sets the level. - `IsAnamorphic` boolean, nullable — Gets a value indicating whether this instance is anamorphic. - `MediaAttachments` MediaAttachment[], nullable - `Codec` string, nullable — Gets or sets the codec. - `CodecTag` string, nullable — Gets or sets the codec tag. - `Comment` string, nullable — Gets or sets the comment. - `Index` integer — Gets or sets the index. - `FileName` string, nullable — Gets or sets the filename. - `MimeType` string, nullable — Gets or sets the MIME type. - `DeliveryUrl` string, nullable — Gets or sets the delivery URL. - `Formats` string[], nullable - `Bitrate` integer, nullable - `Timestamp` 'None' | 'Zero' | 'Valid' - `RequiredHttpHeaders` object, nullable - `TranscodingUrl` string, nullable - `TranscodingSubProtocol` string, nullable - `TranscodingContainer` string, nullable - `AnalyzeDurationMs` integer, nullable - `DefaultAudioStreamIndex` integer, nullable - `DefaultSubtitleStreamIndex` integer, nullable - `CriticRating` number, float, nullable — Gets or sets the critic rating. - `ProductionLocations` string[], nullable - `Path` string, nullable — Gets or sets the path. - `EnableMediaSourceDisplay` boolean, nullable - `OfficialRating` string, nullable — Gets or sets the official rating. - `CustomRating` string, nullable — Gets or sets the custom rating. - `ChannelId` string, uuid, nullable — Gets or sets the channel identifier. - `ChannelName` string, nullable - `Overview` string, nullable — Gets or sets the overview. - `Taglines` string[], nullable — Gets or sets the taglines. - `Genres` string[], nullable — Gets or sets the genres. - `CommunityRating` number, float, nullable — Gets or sets the community rating. - `CumulativeRunTimeTicks` integer, nullable — Gets or sets the cumulative run time ticks. - `RunTimeTicks` integer, nullable — Gets or sets the run time ticks. - `PlayAccess` 'Full' | 'None' - `AspectRatio` string, nullable — Gets or sets the aspect ratio. - `ProductionYear` integer, nullable — Gets or sets the production year. - `IsPlaceHolder` boolean, nullable — Gets or sets a value indicating whether this instance is place holder. - `Number` string, nullable — Gets or sets the number. - `ChannelNumber` string, nullable - `IndexNumber` integer, nullable — Gets or sets the index number. - `IndexNumberEnd` integer, nullable — Gets or sets the index number end. - `ParentIndexNumber` integer, nullable — Gets or sets the parent index number. - `RemoteTrailers` MediaUrl[], nullable — Gets or sets the trailer urls. - `Url` string, nullable - `Name` string, nullable - `ProviderIds` object, nullable — Gets or sets the provider ids. - `IsHD` boolean, nullable — Gets or sets a value indicating whether this instance is HD. - `IsFolder` boolean, nullable — Gets or sets a value indicating whether this instance is folder. - `ParentId` string, uuid, nullable — Gets or sets the parent id. - `Type` string, nullable — Gets or sets the type. - `People` BaseItemPerson[], nullable — Gets or sets the people. - `Name` string, nullable — Gets or sets the name. - `Id` string, nullable — Gets or sets the identifier. - `Role` string, nullable — Gets or sets the role. - `Type` string, nullable — Gets or sets the type. - `PrimaryImageTag` string, nullable — Gets or sets the primary image tag. - `ImageBlurHashes` object, nullable — Gets or sets the primary image blurhash. - `Primary` object - `Art` object - `Backdrop` object - `Banner` object - `Logo` object - `Thumb` object - `Disc` object - `Box` object - `Screenshot` object - `Menu` object - `Chapter` object - `BoxRear` object - `Profile` object - `Studios` NameGuidPair[], nullable — Gets or sets the studios. - `Name` string, nullable - `Id` string, uuid - `GenreItems` NameGuidPair[], nullable - `Name` string, nullable - `Id` string, uuid - `ParentLogoItemId` string, nullable — If the item does not have a logo, this will hold the Id of the Parent that has one. - `ParentBackdropItemId` string, nullable — If the item does not have any backdrops, this will hold the Id of the Parent that has one. - `ParentBackdropImageTags` string[], nullable — Gets or sets the parent backdrop image tags. - `LocalTrailerCount` integer, nullable — Gets or sets the local trailer count. - `UserData` UserItemDataDto — Class UserItemDataDto. - `Rating` number, double, nullable — Gets or sets the rating. - `PlayedPercentage` number, double, nullable — Gets or sets the played percentage. - `UnplayedItemCount` integer, nullable — Gets or sets the unplayed item count. - `PlaybackPositionTicks` integer — Gets or sets the playback position ticks. - `PlayCount` integer — Gets or sets the play count. - `IsFavorite` boolean — Gets or sets a value indicating whether this instance is favorite. - `Likes` boolean, nullable — Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is likes. - `LastPlayedDate` string, date-time, nullable — Gets or sets the last played date. - `Played` boolean — Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is played. - `Key` string, nullable — Gets or sets the key. - `ItemId` string, nullable — Gets or sets the item identifier. - `RecursiveItemCount` integer, nullable — Gets or sets the recursive item count. - `ChildCount` integer, nullable — Gets or sets the child count. - `SeriesName` string, nullable — Gets or sets the name of the series. - `SeriesId` string, uuid, nullable — Gets or sets the series id. - `SeasonId` string, uuid, nullable — Gets or sets the season identifier. - `SpecialFeatureCount` integer, nullable — Gets or sets the special feature count. - `DisplayPreferencesId` string, nullable — Gets or sets the display preferences id. - `Status` string, nullable — Gets or sets the status. - `AirTime` string, nullable — Gets or sets the air time. - `AirDays` DayOfWeek[], nullable — Gets or sets the air days. - `Tags` string[], nullable — Gets or sets the tags. - `PrimaryImageAspectRatio` number, double, nullable — Gets or sets the primary image aspect ratio, after image enhancements. - `Artists` string[], nullable — Gets or sets the artists. - `ArtistItems` NameGuidPair[], nullable — Gets or sets the artist items. - `Name` string, nullable - `Id` string, uuid - `Album` string, nullable — Gets or sets the album. - `CollectionType` string, nullable — Gets or sets the type of the collection. - `DisplayOrder` string, nullable — Gets or sets the display order. - `AlbumId` string, uuid, nullable — Gets or sets the album id. - `AlbumPrimaryImageTag` string, nullable — Gets or sets the album image tag. - `SeriesPrimaryImageTag` string, nullable — Gets or sets the series primary image tag. - `AlbumArtist` string, nullable — Gets or sets the album artist. - `AlbumArtists` NameGuidPair[], nullable — Gets or sets the album artists. - `Name` string, nullable - `Id` string, uuid - `SeasonName` string, nullable — Gets or sets the name of the season. - `MediaStreams` MediaStream[], nullable — Gets or sets the media streams. - `Codec` string, nullable — Gets or sets the codec. - `CodecTag` string, nullable — Gets or sets the codec tag. - `Language` string, nullable — Gets or sets the language. - `ColorRange` string, nullable — Gets or sets the color range. - `ColorSpace` string, nullable — Gets or sets the color space. - `ColorTransfer` string, nullable — Gets or sets the color transfer. - `ColorPrimaries` string, nullable — Gets or sets the color primaries. - `Comment` string, nullable — Gets or sets the comment. - `TimeBase` string, nullable — Gets or sets the time base. - `CodecTimeBase` string, nullable — Gets or sets the codec time base. - `Title` string, nullable — Gets or sets the title. - `VideoRange` string, nullable — Gets or sets the video range. - `localizedUndefined` string, nullable - `localizedDefault` string, nullable - `localizedForced` string, nullable - `DisplayTitle` string, nullable - `NalLengthSize` string, nullable - `IsInterlaced` boolean — Gets or sets a value indicating whether this instance is interlaced. - `IsAVC` boolean, nullable - `ChannelLayout` string, nullable — Gets or sets the channel layout. - `BitRate` integer, nullable — Gets or sets the bit rate. - `BitDepth` integer, nullable — Gets or sets the bit depth. - `RefFrames` integer, nullable — Gets or sets the reference frames. - `PacketLength` integer, nullable — Gets or sets the length of the packet. - `Channels` integer, nullable — Gets or sets the channels. - `SampleRate` integer, nullable — Gets or sets the sample rate. - `IsDefault` boolean — Gets or sets a value indicating whether this instance is default. - `IsForced` boolean — Gets or sets a value indicating whether this instance is forced. - `Height` integer, nullable — Gets or sets the height. - `Width` integer, nullable — Gets or sets the width. - `AverageFrameRate` number, float, nullable — Gets or sets the average frame rate. - `RealFrameRate` number, float, nullable — Gets or sets the real frame rate. - `Profile` string, nullable — Gets or sets the profile. - `Type` 'Audio' | 'Video' | 'Subtitle' | 'EmbeddedImage' — Enum MediaStreamType. - `AspectRatio` string, nullable — Gets or sets the aspect ratio. - `Index` integer — Gets or sets the index. - `Score` integer, nullable — Gets or sets the score. - `IsExternal` boolean — Gets or sets a value indicating whether this instance is external. - `DeliveryMethod` 'Encode' | 'Embed' | 'External' | 'Hls' - `DeliveryUrl` string, nullable — Gets or sets the delivery URL. - `IsExternalUrl` boolean, nullable — Gets or sets a value indicating whether this instance is external URL. - `IsTextSubtitleStream` boolean - `SupportsExternalStream` boolean — Gets or sets a value indicating whether [supports external stream]. - `Path` string, nullable — Gets or sets the filename. - `PixelFormat` string, nullable — Gets or sets the pixel format. - `Level` number, double, nullable — Gets or sets the level. - `IsAnamorphic` boolean, nullable — Gets a value indicating whether this instance is anamorphic. - `VideoType` 'VideoFile' | 'Iso' | 'Dvd' | 'BluRay' — Enum VideoType. - `PartCount` integer, nullable — Gets or sets the part count. - `MediaSourceCount` integer, nullable - `ImageTags` object, nullable — Gets or sets the image tags. - `BackdropImageTags` string[], nullable — Gets or sets the backdrop image tags. - `ScreenshotImageTags` string[], nullable — Gets or sets the screenshot image tags. - `ParentLogoImageTag` string, nullable — Gets or sets the parent logo image tag. - `ParentArtItemId` string, nullable — If the item does not have a art, this will hold the Id of the Parent that has one. - `ParentArtImageTag` string, nullable — Gets or sets the parent art image tag. - `SeriesThumbImageTag` string, nullable — Gets or sets the series thumb image tag. - `ImageBlurHashes` object, nullable — Gets or sets the blurhashes for the image tags. Maps image type to dictionary mapping image tag to blurhash value. - `Primary` object - `Art` object - `Backdrop` object - `Banner` object - `Logo` object - `Thumb` object - `Disc` object - `Box` object - `Screenshot` object - `Menu` object - `Chapter` object - `BoxRear` object - `Profile` object - `SeriesStudio` string, nullable — Gets or sets the series studio. - `ParentThumbItemId` string, nullable — Gets or sets the parent thumb item id. - `ParentThumbImageTag` string, nullable — Gets or sets the parent thumb image tag. - `ParentPrimaryImageItemId` string, nullable — Gets or sets the parent primary image item identifier. - `ParentPrimaryImageTag` string, nullable — Gets or sets the parent primary image tag. - `Chapters` ChapterInfo[], nullable — Gets or sets the chapters. - `StartPositionTicks` integer — Gets or sets the start position ticks. - `Name` string, nullable — Gets or sets the name. - `ImagePath` string, nullable — Gets or sets the image path. - `ImageDateModified` string, date-time - `ImageTag` string, nullable - `LocationType` 'FileSystem' | 'Remote' | 'Virtual' | 'Offline' — Enum LocationType. - `IsoType` 'Dvd' | 'BluRay' — Enum IsoType. - `MediaType` string, nullable — Gets or sets the type of the media. - `EndDate` string, date-time, nullable — Gets or sets the end date. - `LockedFields` MetadataField[], nullable — Gets or sets the locked fields. - `TrailerCount` integer, nullable — Gets or sets the trailer count. - `MovieCount` integer, nullable — Gets or sets the movie count. - `SeriesCount` integer, nullable — Gets or sets the series count. - `ProgramCount` integer, nullable - `EpisodeCount` integer, nullable — Gets or sets the episode count. - `SongCount` integer, nullable — Gets or sets the song count. - `AlbumCount` integer, nullable — Gets or sets the album count. - `ArtistCount` integer, nullable - `MusicVideoCount` integer, nullable — Gets or sets the music video count. - `LockData` boolean, nullable — Gets or sets a value indicating whether [enable internet providers]. - `Width` integer, nullable - `Height` integer, nullable - `CameraMake` string, nullable - `CameraModel` string, nullable - `Software` string, nullable - `ExposureTime` number, double, nullable - `FocalLength` number, double, nullable - `ImageOrientation` 'TopLeft' | 'TopRight' | 'BottomRight' | 'BottomLeft' | 'LeftTop' | 'RightTop' | 'RightBottom' | 'LeftBottom' - `Aperture` number, double, nullable - `ShutterSpeed` number, double, nullable - `Latitude` number, double, nullable - `Longitude` number, double, nullable - `Altitude` number, double, nullable - `IsoSpeedRating` integer, nullable - `SeriesTimerId` string, nullable — Gets or sets the series timer identifier. - `ProgramId` string, nullable — Gets or sets the program identifier. - `ChannelPrimaryImageTag` string, nullable — Gets or sets the channel primary image tag. - `StartDate` string, date-time, nullable — The start date of the recording, in UTC. - `CompletionPercentage` number, double, nullable — Gets or sets the completion percentage. - `IsRepeat` boolean, nullable — Gets or sets a value indicating whether this instance is repeat. - `EpisodeTitle` string, nullable — Gets or sets the episode title. - `ChannelType` 'TV' | 'Radio' — Enum ChannelType. - `Audio` 'Mono' | 'Stereo' | 'Dolby' | 'DolbyDigital' | 'Thx' | 'Atmos' - `IsMovie` boolean, nullable — Gets or sets a value indicating whether this instance is movie. - `IsSports` boolean, nullable — Gets or sets a value indicating whether this instance is sports. - `IsSeries` boolean, nullable — Gets or sets a value indicating whether this instance is series. - `IsLive` boolean, nullable — Gets or sets a value indicating whether this instance is live. - `IsNews` boolean, nullable — Gets or sets a value indicating whether this instance is news. - `IsKids` boolean, nullable — Gets or sets a value indicating whether this instance is kids. - `IsPremiere` boolean, nullable — Gets or sets a value indicating whether this instance is premiere. - `TimerId` string, nullable — Gets or sets the timer identifier. - `CurrentProgram` BaseItemDto — recursive - `DeviceId` string, nullable — Gets or sets the device id. - `ApplicationVersion` string, nullable — Gets or sets the application version. - `TranscodingInfo` TranscodingInfo - `AudioCodec` string, nullable - `VideoCodec` string, nullable - `Container` string, nullable - `IsVideoDirect` boolean - `IsAudioDirect` boolean - `Bitrate` integer, nullable - `Framerate` number, float, nullable - `CompletionPercentage` number, double, nullable - `Width` integer, nullable - `Height` integer, nullable - `AudioChannels` integer, nullable - `TranscodeReasons` TranscodeReason[], nullable - `IsActive` boolean — Gets a value indicating whether this instance is active. - `SupportsMediaControl` boolean - `SupportsRemoteControl` boolean - `NowPlayingQueue` QueueItem[], nullable - `Id` string, uuid - `PlaylistItemId` string, nullable - `HasCustomDeviceName` boolean - `PlaylistItemId` string, nullable - `ServerId` string, nullable - `UserPrimaryImageTag` string, nullable - `SupportedCommands` GeneralCommandType[], nullable — Gets or sets the supported commands. - `AccessToken` string, nullable - `ServerId` string, nullable ## Other responses - `403` — Sha1-hashed password only is not allowed. - `404` — User not found. --- [API](https://skmtc.net/jellyfin/apis/jellyfin-api.md) · [All operations](https://skmtc.net/jellyfin/apis/jellyfin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jellyfin/jellyfin-api/versions/eb6f75af7066/schema)