本文档由新疆萌森软件开发工作室提供技术支持
- 说明文档
- 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
Get Display Preferences.
GET
/DisplayPreferences/{displayPreferencesId}
最后修改时间：2025-05-09 13:10:14
请求参数
Authorization
在 header 添加参数
X-Emby-Token
示例：
X-Emby-Token: ********************Path 参数
displayPreferencesId
string
必需
Query 参数
userId
string <uuid>
User id.
client
string
Client.
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/DisplayPreferences/?userId&client' \
--header 'X-Emby-Token;'返回响应
🟢200成功
application/json
Body
Defines the display preferences for any item that supports them (usually Folders).
Id
string | null
可选
ViewType
string | null
可选
SortBy
string | null
可选
IndexBy
string | null
可选
RememberIndexing
boolean
可选
PrimaryImageHeight
integer <int32>
可选
PrimaryImageWidth
integer <int32>
可选
CustomPrefs
object
可选
额外字段
string | null
可选
ScrollDirection
enum<string>
可选
枚举值:
HorizontalVertical
ShowBackdrop
boolean
可选
RememberSorting
boolean
可选
SortOrder
enum<string>
可选
枚举值:
AscendingDescending
ShowSidebar
boolean
可选
Client
string | null
可选
示例
{
"Id": "string",
"ViewType": "string",
"SortBy": "string",
"IndexBy": "string",
"RememberIndexing": true,
"PrimaryImageHeight": 0,
"PrimaryImageWidth": 0,
"CustomPrefs": {
"property1": "string",
"property2": "string"
},
"ScrollDirection": "Horizontal",
"ShowBackdrop": true,
"RememberSorting": true,
"SortOrder": "Ascending",
"ShowSidebar": true,
"Client": "string"
}🟠401没有权限
🟠403禁止访问
人生足迹 · 店铺
远程在线技术服务平台，1对1的技术支持
服务列表
萌森软件开发工作室
关注微信公众号，新资源，总是快人一步
微信公众号修改于 2025-05-09 13:10:14