- 说明文档
- ActivityLog
- ApiKey
- Artists
- Audio
- Channels
- ClientLog
- Collection
- Configuration
- Dashboard
- Devices
- DisplayPreferences
- DynamicHls
- Gets a video stream using HTTP live streaming.
- Gets an audio stream using HTTP live streaming.
- Gets an audio hls playlist stream.
- Gets an audio hls playlist stream.
- Gets a video stream using HTTP live streaming.
- Gets a hls live stream.
- Gets a video stream using HTTP live streaming.
- Gets a video hls playlist stream.
- Gets a video hls playlist stream.
- Environment
- Filter
- Genres
- HlsSegment
- Image
- Get artist image by name.
- Get artist image by name.
- Generates or gets the splashscreen.
- Uploads a custom splashscreen. The body is expected to the image contents base64 encoded.
- Delete a custom splashscreen.
- Get genre image by name.
- Get genre image by name.
- Get genre image by name.
- Get genre image by name.
- Get item image infos.
- Delete an item's image.
- Set item image.
- Gets the item's image.
- Gets the item's image.
- Delete an item's image.
- Set item image.
- Gets the item's image.
- Gets the item's image.
- Gets the item's image.
- Gets the item's image.
- Updates the index for an item image.
- Get music genre image by name.
- Get music genre image by name.
- Get music genre image by name.
- Get music genre image by name.
- Get person image by name.
- Get person image by name.
- Get person image by name.
- Get person image by name.
- Get studio image by name.
- Get studio image by name.
- Get studio image by name.
- Get studio image by name.
- Sets the user image.
- Delete the user's image.
- Get user profile image.
- Get user profile image.
- InstantMix
- Creates an instant playlist based on a given album.
- Creates an instant playlist based on a given artist.
- Creates an instant playlist based on a given artist.
- Creates an instant playlist based on a given item.
- Creates an instant playlist based on a given genre.
- Creates an instant playlist based on a given genre.
- Creates an instant playlist based on a given playlist.
- Creates an instant playlist based on a given song.
- ItemLookup
- Get the item's external id info.
- Applies search criteria to an item and refreshes metadata.
- Get book remote search.
- Get box set remote search.
- Get movie remote search.
- Get music album remote search.
- Get music artist remote search.
- Get music video remote search.
- Get person remote search.
- Get series remote search.
- Get trailer remote search.
- Library
- Deletes items from the library and filesystem.
- Deletes an item from the library and filesystem.
- Gets similar items.
- Gets similar items.
- Gets all parents of an item.
- Gets critic review for an item.
- Downloads item media.
- Get the original file of an item.
- Gets similar items.
- Get theme songs and videos for an item.
- Get theme songs for an item.
- Get theme videos for an item.
- Get item counts.
- Gets the library options info.
- Reports that new movies have been added by an external source.
- Gets all user media folders.
- Reports that new movies have been added by an external source.
- Reports that new movies have been added by an external source.
- Gets a list of physical paths from virtual folders.
- Starts a library scan.
- Reports that new episodes of a series have been added by an external source.
- Reports that new episodes of a series have been added by an external source.
- Gets similar items.
- Gets similar items.
- Gets similar items.
- ItemUpdate
- UserLibrary
- Gets an item from a user's library.
- Gets intros to play before the main media item plays.
- Gets local trailers for an item.
- Gets special features for an item.
- Gets latest media.
- Gets the root folder from a user's library.
- Marks an item as a favorite.
- Unmarks item as a favorite.
- Deletes a user's saved personal rating for an item.
- Updates a user's rating for an item.
- LiveTv
- Get channel mapping options.
- Set channel mappings.
- Gets available live tv channels.
- Gets a live tv channel.
- Get guid info.
- Gets available live tv services.
- Adds a listings provider.
- Delete listing provider.
- Gets default listings provider info.
- Gets available lineups.
- Gets available countries.
- Gets a live tv recording stream.
- Gets a live tv channel stream.
- Gets available live tv epgs.
- Gets available live tv epgs.
- Gets a live tv program.
- Gets recommended live tv epgs.
- Gets live tv recordings.
- Gets a live tv recording.
- Deletes a live tv recording.
- Gets recording folders.
- Gets live tv recording groups.
- Get recording group.
- Gets live tv recording series.
- Gets live tv series timers.
- Creates a live tv series timer.
- Gets a live tv series timer.
- Cancels a live tv series timer.
- Updates a live tv series timer.
- Gets the live tv timers.
- Creates a live tv timer.
- Gets a timer.
- Cancels a live tv timer.
- Updates a live tv timer.
- Gets the default values for a new timer.
- Adds a tuner host.
- Deletes a tuner host.
- Get tuner host types.
- Resets a tv tuner.
- Discover tuners.
- Discover tuners.
- Localization
- Lyrics
- MediaInfo
- MediaSegments
- Movies
- MusicGenres
- Package
- Persons
- Playlists
- Playstate
- Reports that a session has begun playing an item.
- Reports that a session has stopped playing an item.
- Reports a session's playback progress.
- Reports playback has started within a session.
- Pings a playback session.
- Reports playback progress within a session.
- Reports playback has stopped within a session.
- Marks an item as played for user.
- Marks an item as unplayed for user.
- Plugins
- QuickConnect
- RemoteImage
- ScheduledTasks
- Search
- Session
- Get all password reset providers.
- Get all auth providers.
- Gets a list of sessions.
- Issues a full general command to a client.
- Issues a general command to a client.
- Issues a command to a client to display a message to the user.
- Instructs a session to play an item.
- Issues a playstate command to a client.
- Issues a system command to a client.
- Adds an additional user to a session.
- Removes an additional user from a session.
- Instructs a session to browse to an item or view.
- Updates capabilities for a device.
- Updates capabilities for a device.
- Reports that a session has ended.
- Reports that a session is viewing an item.
- Startup
- Studios
- Subtitle
- Gets a list of available fallback font files.
- Gets a fallback font file.
- Search remote subtitles.
- Downloads a remote subtitle.
- Gets the remote subtitles.
- Gets an HLS subtitle playlist.
- Upload an external subtitle file.
- Deletes an external subtitle file.
- Gets subtitles in a specified format.
- Gets subtitles in a specified format.
- Suggestions
- SyncPlay
- Notify SyncPlay group that member is buffering.
- Join an existing SyncPlay group.
- Leave the joined SyncPlay group.
- Gets all SyncPlay groups.
- Request to move an item in the playlist in SyncPlay group.
- Create a new SyncPlay group.
- Request next item in SyncPlay group.
- Request pause in SyncPlay group.
- Update session ping.
- Request previous item in SyncPlay group.
- Request to queue items to the playlist of a SyncPlay group.
- Notify SyncPlay group that member is ready for playback.
- Request to remove items from the playlist in SyncPlay group.
- Request seek in SyncPlay group.
- Request SyncPlay group to ignore member during group-wait.
- Request to set new playlist in SyncPlay group.
- Request to change playlist item in SyncPlay group.
- Request to set repeat mode in SyncPlay group.
- Request to set shuffle mode in SyncPlay group.
- Request stop in SyncPlay group.
- Request unpause in SyncPlay group.
- System
- TimeSync
- Tmdb
- Trailers
- Trickplay
- TvShows
- UniversalAudio
- User
- Gets a list of users.
- Updates a user.
- Gets a user by Id.
- Deletes a user.
- Updates a user policy.
- Authenticates a user by name.
- Authenticates a user with quick connect.
- Updates a user configuration.
- Initiates the forgot password process for a local user.
- Redeems a forgot password pin.
- Gets the user based on auth token.
- Creates a user.
- Updates a user's password.
- Gets a list of publicly visible users for display on a login screen.
- UserViews
- VideoAttachments
- Videos
- Years
- Branding
- ItemRefresh
- Items
- LibraryStructure
Updates an item.
POST
/Items/{itemId}
ItemUpdate
最后修改时间:2025-04-15 07:17:25
请求参数
Authorization
在 header 添加参数
X-Emby-Token
示例:
X-Emby-Token: ********************
Path 参数
itemId
string <uuid>
必需
Body 参数application/json
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 | null
可选
OriginalTitle
string | null
可选
ServerId
string | null
可选
Id
string <uuid>
可选
Etag
string | null
可选
SourceType
string | null
可选
PlaylistItemId
string | null
可选
DateCreated
string <date-time> | null
可选
DateLastMediaAdded
string <date-time> | null
可选
ExtraType
enum<null> | enum<allOf> {1}
可选
枚举值:
UnknownClipTrailerBehindTheScenesDeletedSceneInterviewSceneSampleThemeSongThemeVideoFeaturetteShort
enum<string>
可选
枚举值:
UnknownClipTrailerBehindTheScenesDeletedSceneInterviewSceneSampleThemeSongThemeVideoFeaturetteShort
AirsBeforeSeasonNumber
integer <int32> | null
可选
AirsAfterSeasonNumber
integer <int32> | null
可选
AirsBeforeEpisodeNumber
integer <int32> | null
可选
CanDelete
boolean | null
可选
CanDownload
boolean | null
可选
HasLyrics
boolean | null
可选
HasSubtitles
boolean | null
可选
PreferredMetadataLanguage
string | null
可选
PreferredMetadataCountryCode
string | null
可选
Container
string | null
可选
SortName
string | null
可选
ForcedSortName
string | null
可选
Video3DFormat
enum<null> | enum<allOf> {1}
可选
枚举值:
HalfSideBySideFullSideBySideFullTopAndBottomHalfTopAndBottomMVC
enum<string>
可选
枚举值:
HalfSideBySideFullSideBySideFullTopAndBottomHalfTopAndBottomMVC
PremiereDate
string <date-time> | null
可选
ExternalUrls
array[object (ExternalUrl) {2}] | null
可选
Name
string | null
可选
Url
string | null
可选
MediaSources
array[object (MediaSourceInfo) {45}] | null
可选
Protocol
enum<string>
可选
枚举值:
FileHttpRtmpRtspUdpRtpFtp
Id
string | null
可选
Path
string | null
可选
EncoderPath
string | null
可选
EncoderProtocol
enum<null> | enum<allOf> {1}
可选
枚举值:
FileHttpRtmpRtspUdpRtpFtp
Type
enum<string>
可选
枚举值:
DefaultGroupingPlaceholder
Container
string | null
可选
Size
integer <int64> | null
可选
Name
string | null
可选
IsRemote
boolean
可选
Differentiate internet url vs local network.
ETag
string | null
可选
RunTimeTicks
integer <int64> | null
可选
ReadAtNativeFramerate
boolean
可选
IgnoreDts
boolean
可选
IgnoreIndex
boolean
可选
GenPtsInput
boolean
可选
SupportsTranscoding
boolean
可选
SupportsDirectStream
boolean
可选
SupportsDirectPlay
boolean
可选
IsInfiniteStream
boolean
可选
UseMostCompatibleTranscodingProfile
boolean
可选
默认值:
false
RequiresOpening
boolean
可选
OpenToken
string | null
可选
RequiresClosing
boolean
可选
LiveStreamId
string | null
可选
BufferMs
integer <int32> | null
可选
RequiresLooping
boolean
可选
SupportsProbing
boolean
可选
VideoType
enum<null> | enum<allOf> {1}
可选
枚举值:
VideoFileIsoDvdBluRay
IsoType
enum<null> | enum<allOf> {1}
可选
枚举值:
DvdBluRay
Video3DFormat
enum<null> | enum<allOf> {1}
可选
枚举值:
HalfSideBySideFullSideBySideFullTopAndBottomHalfTopAndBottomMVC
MediaStreams
array[object (MediaStream) {56}] | null
可选
MediaAttachments
array[object (MediaAttachment) {7}] | null
可选
Formats
array[string] | null
可选
Bitrate
integer <int32> | null
可选
FallbackMaxStreamingBitrate
integer <int32> | null
可选
Timestamp
enum<null> | enum<allOf> {1}
可选
枚举值:
NoneZeroValid
RequiredHttpHeaders
object | null
可选
TranscodingUrl
string | null
可选
TranscodingSubProtocol
enum<string>
可选
Lowercase for backwards compatibility.
枚举值:
httphls
TranscodingContainer
string | null
可选
AnalyzeDurationMs
integer <int32> | null
可选
DefaultAudioStreamIndex
integer <int32> | null
可选
DefaultSubtitleStreamIndex
integer <int32> | null
可选
HasSegments
boolean
可选
CriticRating
number <float> | null
可选
ProductionLocations
array[string] | null
可选
Path
string | null
可选
EnableMediaSourceDisplay
boolean | null
可选
OfficialRating
string | null
可选
CustomRating
string | null
可选
ChannelId
string <uuid> | null
可选
ChannelName
string | null
可选
Overview
string | null
可选
Taglines
array[string] | null
可选
Genres
array[string] | null
可选
CommunityRating
number <float> | null
可选
CumulativeRunTimeTicks
integer <int64> | null
可选
RunTimeTicks
integer <int64> | null
可选
PlayAccess
enum<null> | enum<allOf> {1}
可选
枚举值:
FullNone
enum<string>
可选
枚举值:
FullNone
AspectRatio
string | null
可选
ProductionYear
integer <int32> | null
可选
IsPlaceHolder
boolean | null
可选
Number
string | null
可选
ChannelNumber
string | null
可选
IndexNumber
integer <int32> | null
可选
IndexNumberEnd
integer <int32> | null
可选
ParentIndexNumber
integer <int32> | null
可选
RemoteTrailers
array[object (MediaUrl) {2}] | null
可选
Url
string | null
可选
Name
string | null
可选
ProviderIds
object | null
可选
IsHD
boolean | null
可选
IsFolder
boolean | null
可选
ParentId
string <uuid> | null
可选
Type
enum<string>
可选
枚举值:
AggregateFolderAudioAudioBookBasePluginFolderBookBoxSetChannelChannelFolderItemCollectionFolderEpisodeFolderGenreManualPlaylistsFolderMovieLiveTvChannelLiveTvProgramMusicAlbumMusicArtistMusicGenreMusicVideoPersonPhotoPhotoAlbumPlaylistPlaylistsFolderProgramRecordingSeasonSeriesStudioTrailerTvChannelTvProgramUserRootFolderUserViewVideoYear
People
array[object (BaseItemPerson) {6}] | null
可选
Name
string | null
可选
Id
string <uuid>
可选
Role
string | null
可选
Type
enum<string>
可选
枚举值:
UnknownActorDirectorComposerWriterGuestStarProducerConductorLyricistArrangerEngineerMixerRemixerCreatorArtistAlbumArtistAuthorIllustratorPencillerInkerColoristLettererCoverArtistEditorTranslator
默认值:
Unknown
PrimaryImageTag
string | null
可选
ImageBlurHashes
object | null
可选
Studios
array[object (NameGuidPair) {2}] | null
可选
Name
string | null
可选
Id
string <uuid>
可选
GenreItems
array[object (NameGuidPair) {2}] | null
可选
Name
string | null
可选
Id
string <uuid>
可选
ParentLogoItemId
string <uuid> | null
可选
ParentBackdropItemId
string <uuid> | null
可选
ParentBackdropImageTags
array[string] | null
可选
LocalTrailerCount
integer <int32> | null
可选
UserData
null | allOf {1}
可选
object (UserItemDataDto)
可选
RecursiveItemCount
integer <int32> | null
可选
ChildCount
integer <int32> | null
可选
SeriesName
string | null
可选
SeriesId
string <uuid> | null
可选
SeasonId
string <uuid> | null
可选
SpecialFeatureCount
integer <int32> | null
可选
DisplayPreferencesId
string | null
可选
Status
string | null
可选
AirTime
string | null
可选
AirDays
array[string] | null
可选
枚举值:
SundayMondayTuesdayWednesdayThursdayFridaySaturday
Tags
array[string] | null
可选
PrimaryImageAspectRatio
number <double> | null
可选
Artists
array[string] | null
可选
ArtistItems
array[object (NameGuidPair) {2}] | null
可选
Name
string | null
可选
Id
string <uuid>
可选
Album
string | null
可选
CollectionType
enum<null> | enum<allOf> {1}
可选
枚 举值:
unknownmoviestvshowsmusicmusicvideostrailershomevideosboxsetsbooksphotoslivetvplaylistsfolders
enum<string>
可选
枚举值:
unknownmoviestvshowsmusicmusicvideostrailershomevideosboxsetsbooksphotoslivetvplaylistsfolders
DisplayOrder
string | null
可选
AlbumId
string <uuid> | null
可选
AlbumPrimaryImageTag
string | null
可选
SeriesPrimaryImageTag
string | null
可选
AlbumArtist
string | null
可选
AlbumArtists
array[object (NameGuidPair) {2}] | null
可选
Name
string | null
可选
Id
string <uuid>
可选
SeasonName
string | null
可选
MediaStreams
array[object (MediaStream) {56}] | null
可选
Codec
string | null
可选
CodecTag
string | null
可选
Language
string | null
可选
ColorRange
string | null
可选
ColorSpace
string | null
可选
ColorTransfer
string | null
可选
ColorPrimaries
string | null
可选
DvVersionMajor
integer <int32> | null
可选
DvVersionMinor
integer <int32> | null
可选
DvProfile
integer <int32> | null
可选
DvLevel
integer <int32> | null
可选
RpuPresentFlag
integer <int32> | null
可选
ElPresentFlag
integer <int32> | null
可选
BlPresentFlag
integer <int32> | null
可选
DvBlSignalCompatibilityId
integer <int32> | null
可选
Rotation
integer <int32> | null
可选
Comment
string | null
可选
TimeBase
string | null
可选
CodecTimeBase
string | null
可选
Title
string | null
可选
LocalizedUndefined
string | null
可选
LocalizedDefault
string | null
可选
LocalizedForced
string | null
可选
LocalizedExternal
string | null
可选
LocalizedHearingImpaired
string | null
可选
NalLengthSize
string | null
可选
IsInterlaced
boolean
可选
IsAVC
boolean | null
可选
ChannelLayout
string | null
可选
BitRate
integer <int32> | null
可选
BitDepth
integer <int32> | null
可选
RefFrames
integer <int32> | null
可选
PacketLength
integer <int32> | null
可选
Channels
integer <int32> | null
可选
SampleRate
integer <int32> | null
可选
IsDefault
boolean
可选
IsForced
boolean
可选
IsHearingImpaired
boolean
可选
Height
integer <int32> | null
可选
Width
integer <int32> | null
可选
AverageFrameRate
number <float> | null
可选
RealFrameRate
number <float> | null
可选
Profile
string | null
可选
Type
enum<string>
可选
枚举值:
AudioVideoSubtitleEmbeddedImageDataLyric
AspectRatio
string | null
可选
Index
integer <int32>
可选
Score
integer <int32> | null
可选
IsExternal
boolean
可选
DeliveryMethod
enum<null> | enum<allOf> {1}
可选
枚举值:
EncodeEmbedExternalHlsDrop
DeliveryUrl
string | null
可选
IsExternalUrl
boolean | null
可选
SupportsExternalStream
boolean
可选
Path
string | null
可选
PixelFormat
string | null
可选
Level
number <double> | null
可选
IsAnamorphic
boolean | null
可选
VideoType
enum<null> | enum<allOf> {1}
可选
枚举值:
VideoFileIsoDvdBluRay
enum<string>
可选
枚举值:
VideoFileIsoDvdBluRay
PartCount
integer <int32> | null
可选
MediaSourceCount
integer <int32> | null
可选
ImageTags
object | null
可选
BackdropImageTags
array[string] | null
可选
ScreenshotImageTags
array[string] | null
可选
ParentLogoImageTag
string | null
可选
ParentArtItemId
string <uuid> | null
可选
ParentArtImageTag
string | null
可选
SeriesThumbImageTag
string | null
可选
ImageBlurHashes
object | null
可选
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 | null
可选
ParentThumbItemId
string <uuid> | null
可选
ParentThumbImageTag
string | null
可选
ParentPrimaryImageItemId
string | null
可选
ParentPrimaryImageTag
string | null
可选
Chapters
array[object (ChapterInfo) {5}] | null
可选
StartPositionTicks
integer <int64>
可选
Name
string | null
可选
ImagePath
string | null
可选
ImageDateModified
string <date-time>
可选
ImageTag
string | null
可选
Trickplay
object | null
可选
LocationType
enum<null> | enum<allOf> {1}
可选
枚举值:
FileSystemRemoteVirtualOffline
enum<string>
可选
枚举值:
FileSystemRemoteVirtualOffline
IsoType
enum<null> | enum<allOf> {1}
可选
枚举值:
DvdBluRay
enum<string>
可选
枚举值:
DvdBluRay
MediaType
enum<string>
可选
枚举值:
UnknownVideoAudioPhotoBook
默认值:
Unknown
EndDate
string <date-time> | null
可选
LockedFields
array[string] | null
可选
枚举值:
CastGenresProductionLocationsStudiosTagsNameOverviewRuntimeOfficialRating
TrailerCount
integer <int32> | null
可选
MovieCount
integer <int32> | null
可选
SeriesCount
integer <int32> | null
可选
ProgramCount
integer <int32> | null
可选
EpisodeCount
integer <int32> | null
可选
SongCount
integer <int32> | null
可选
AlbumCount
integer <int32> | null
可选
ArtistCount
integer <int32> | null
可选
MusicVideoCount
integer <int32> | null
可选
LockData
boolean | null
可选
Width
integer <int32> | null
可选
Height
integer <int32> | null
可选
CameraMake
string | null
可选
CameraModel
string | null
可选
Software
string | null
可选
ExposureTime
number <double> | null
可选
FocalLength
number <double> | null
可选
ImageOrientation
enum<null> | enum<allOf> {1}
可选
枚举值:
TopLeftTopRightBottomRightBottomLeftLeftTopRightTopRightBottomLeftBottom
enum<string>
可选
枚举值:
TopLeftTopRightBottomRightBottomLeftLeftTopRightTopRightBottomLeftBottom
Aperture
number <double> | null
可选
ShutterSpeed
number <double> | null
可选
Latitude
number <double> | null
可选
Longitude
number <double> | null
可选
Altitude
number <double> | null
可选
IsoSpeedRating
integer <int32> | null
可选
SeriesTimerId
string | null
可选
ProgramId
string | null
可选
ChannelPrimaryImageTag
string | null
可选
StartDate
string <date-time> | null