jellyfin-model/org.jellyfin.sdk.model.api

Package-level declarations

Types

@Serializable

data class AccessSchedule(val id: Int, val userId: UUID, val dayOfWeek: DynamicDayOfWeek, val startHour: Double, val endHour: Double)

An entity representing a user's access schedule.

ActivityLogEntry

@Serializable

data class ActivityLogEntry(val id: Long, val name: String, val overview: String? = null, val shortOverview: String? = null, val type: String, val itemId: String? = null, val date: DateTime, val userId: UUID, val userPrimaryImageTag: String? = null, val severity: LogLevel)

An activity log entry.

ActivityLogEntryQueryResult

@Serializable

data class ActivityLogEntryQueryResult(val items: List<ActivityLogEntry>? = null, val totalRecordCount: Int, val startIndex: Int)

AddVirtualFolderDto

@Serializable

data class AddVirtualFolderDto(val libraryOptions: LibraryOptions? = null)

Add virtual folder dto.

AdminNotificationDto

@Serializable

data class AdminNotificationDto(val name: String? = null, val description: String? = null, val notificationLevel: NotificationLevel? = null, val url: String? = null)

The admin notification dto.

AlbumInfo

@Serializable

data class AlbumInfo(val name: String? = null, val originalTitle: String? = null, val path: String? = null, val metadataLanguage: String? = null, val metadataCountryCode: String? = null, val providerIds: Map<String, String?>? = null, val year: Int? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val premiereDate: DateTime? = null, val isAutomated: Boolean, val albumArtists: List<String>, val artistProviderIds: Map<String, String?>, val songInfos: List<SongInfo>)

AlbumInfoRemoteSearchQuery

@Serializable

data class AlbumInfoRemoteSearchQuery(val searchInfo: AlbumInfo? = null, val itemId: UUID, val searchProviderName: String? = null, val includeDisabledProviders: Boolean)

AllThemeMediaResult

@Serializable

data class AllThemeMediaResult(val themeVideosResult: ThemeMediaResult? = null, val themeSongsResult: ThemeMediaResult? = null, val soundtrackSongsResult: ThemeMediaResult? = null)

Architecture

@Serializable

enum Architecture : Enum<Architecture>

ArtistInfo

@Serializable

data class ArtistInfo(val name: String? = null, val originalTitle: String? = null, val path: String? = null, val metadataLanguage: String? = null, val metadataCountryCode: String? = null, val providerIds: Map<String, String?>? = null, val year: Int? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val premiereDate: DateTime? = null, val isAutomated: Boolean, val songInfos: List<SongInfo>)

ArtistInfoRemoteSearchQuery

@Serializable

data class ArtistInfoRemoteSearchQuery(val searchInfo: ArtistInfo? = null, val itemId: UUID, val searchProviderName: String? = null, val includeDisabledProviders: Boolean)

AuthenticateUserByName

@Serializable

data class AuthenticateUserByName(val username: String? = null, val pw: String? = null, val password: String? = null)

The authenticate user by name request body.

AuthenticationInfo

@Serializable

data class AuthenticationInfo(val id: Long, val accessToken: String? = null, val deviceId: String? = null, val appName: String? = null, val appVersion: String? = null, val deviceName: String? = null, val userId: UUID, val isActive: Boolean, val dateCreated: DateTime, val dateRevoked: DateTime? = null, val dateLastActivity: DateTime, val userName: String? = null)

AuthenticationInfoQueryResult

@Serializable

data class AuthenticationInfoQueryResult(val items: List<AuthenticationInfo>? = null, val totalRecordCount: Int, val startIndex: Int)

AuthenticationResult

@Serializable

data class AuthenticationResult(val user: UserDto? = null, val sessionInfo: SessionInfo? = null, val accessToken: String? = null, val serverId: String? = null)

BaseItem

@Serializable

data class BaseItem(val size: Long? = null, val container: String? = null, val isHd: Boolean, val isShortcut: Boolean, val shortcutPath: String? = null, val width: Int, val height: Int, val extraIds: List<UUID>? = null, val dateLastSaved: DateTime, val remoteTrailers: List<MediaUrl>? = null, val supportsExternalTransfer: Boolean)

Class BaseItem.

BaseItemDto

@Serializable

data class BaseItemDto(val name: String? = null, val originalTitle: String? = null, val serverId: String? = null, val id: UUID, val etag: String? = null, val sourceType: String? = null, val playlistItemId: String? = null, val dateCreated: DateTime? = null, val dateLastMediaAdded: DateTime? = null, val extraType: String? = null, val airsBeforeSeasonNumber: Int? = null, val airsAfterSeasonNumber: Int? = null, val airsBeforeEpisodeNumber: Int? = null, val canDelete: Boolean? = null, val canDownload: Boolean? = null, val hasSubtitles: Boolean? = null, val preferredMetadataLanguage: String? = null, val preferredMetadataCountryCode: String? = null, val supportsSync: Boolean? = null, val container: String? = null, val sortName: String? = null, val forcedSortName: String? = null, val video3dFormat: Video3dFormat? = null, val premiereDate: DateTime? = null, val externalUrls: List<ExternalUrl>? = null, val mediaSources: List<MediaSourceInfo>? = null, val criticRating: Float? = null, val productionLocations: List<String>? = null, val path: String? = null, val enableMediaSourceDisplay: Boolean? = null, val officialRating: String? = null, val customRating: String? = null, val channelId: UUID? = null, val channelName: String? = null, val overview: String? = null, val taglines: List<String>? = null, val genres: List<String>? = null, val communityRating: Float? = null, val cumulativeRunTimeTicks: Long? = null, val runTimeTicks: Long? = null, val playAccess: PlayAccess? = null, val aspectRatio: String? = null, val productionYear: Int? = null, val isPlaceHolder: Boolean? = null, val number: String? = null, val channelNumber: String? = null, val indexNumber: Int? = null, val indexNumberEnd: Int? = null, val parentIndexNumber: Int? = null, val remoteTrailers: List<MediaUrl>? = null, val providerIds: Map<String, String?>? = null, val isHd: Boolean? = null, val isFolder: Boolean? = null, val parentId: UUID? = null, val type: BaseItemKind, val people: List<BaseItemPerson>? = null, val studios: List<NameGuidPair>? = null, val genreItems: List<NameGuidPair>? = null, val parentLogoItemId: UUID? = null, val parentBackdropItemId: UUID? = null, val parentBackdropImageTags: List<String>? = null, val localTrailerCount: Int? = null, val userData: UserItemDataDto? = null, val recursiveItemCount: Int? = null, val childCount: Int? = null, val seriesName: String? = null, val seriesId: UUID? = null, val seasonId: UUID? = null, val specialFeatureCount: Int? = null, val displayPreferencesId: String? = null, val status: String? = null, val airTime: String? = null, val airDays: List<DayOfWeek>? = null, val tags: List<String>? = null, val primaryImageAspectRatio: Double? = null, val artists: List<String>? = null, val artistItems: List<NameGuidPair>? = null, val album: String? = null, val collectionType: String? = null, val displayOrder: String? = null, val albumId: UUID? = null, val albumPrimaryImageTag: String? = null, val seriesPrimaryImageTag: String? = null, val albumArtist: String? = null, val albumArtists: List<NameGuidPair>? = null, val seasonName: String? = null, val mediaStreams: List<MediaStream>? = null, val videoType: VideoType? = null, val partCount: Int? = null, val mediaSourceCount: Int? = null, val imageTags: Map<ImageType, String>? = null, val backdropImageTags: List<String>? = null, val screenshotImageTags: List<String>? = null, val parentLogoImageTag: String? = null, val parentArtItemId: UUID? = null, val parentArtImageTag: String? = null, val seriesThumbImageTag: String? = null, val imageBlurHashes: Map<ImageType, Map<String, String>>? = null, val seriesStudio: String? = null, val parentThumbItemId: UUID? = null, val parentThumbImageTag: String? = null, val parentPrimaryImageItemId: String? = null, val parentPrimaryImageTag: String? = null, val chapters: List<ChapterInfo>? = null, val locationType: LocationType? = null, val isoType: IsoType? = null, val mediaType: String? = null, val endDate: DateTime? = null, val lockedFields: List<MetadataField>? = null, val trailerCount: Int? = null, val movieCount: Int? = null, val seriesCount: Int? = null, val programCount: Int? = null, val episodeCount: Int? = null, val songCount: Int? = null, val albumCount: Int? = null, val artistCount: Int? = null, val musicVideoCount: Int? = null, val lockData: Boolean? = null, val width: Int? = null, val height: Int? = null, val cameraMake: String? = null, val cameraModel: String? = null, val software: String? = null, val exposureTime: Double? = null, val focalLength: Double? = null, val imageOrientation: ImageOrientation? = null, val aperture: Double? = null, val shutterSpeed: Double? = null, val latitude: Double? = null, val longitude: Double? = null, val altitude: Double? = null, val isoSpeedRating: Int? = null, val seriesTimerId: String? = null, val programId: String? = null, val channelPrimaryImageTag: String? = null, val startDate: DateTime? = null, val completionPercentage: Double? = null, val isRepeat: Boolean? = null, val episodeTitle: String? = null, val channelType: ChannelType? = null, val audio: ProgramAudio? = null, val isMovie: Boolean? = null, val isSports: Boolean? = null, val isSeries: Boolean? = null, val isLive: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isPremiere: Boolean? = null, val timerId: String? = null, val currentProgram: BaseItemDto? = null)

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.

BaseItemDtoQueryResult

@Serializable

data class BaseItemDtoQueryResult(val items: List<BaseItemDto>? = null, val totalRecordCount: Int, val startIndex: Int)

BaseItemKind

@Serializable

enum BaseItemKind : Enum<BaseItemKind>

The base item kind.

BaseItemPerson

@Serializable

data class BaseItemPerson(val name: String? = null, val id: UUID, val role: String? = null, val type: String? = null, val primaryImageTag: String? = null, val imageBlurHashes: Map<ImageType, Map<String, String>>? = null)

This is used by the api to get information about a Person within a BaseItem.

BasePluginConfiguration

@Serializable

class BasePluginConfiguration

Class BasePluginConfiguration.

BookInfo

@Serializable

data class BookInfo(val name: String? = null, val originalTitle: String? = null, val path: String? = null, val metadataLanguage: String? = null, val metadataCountryCode: String? = null, val providerIds: Map<String, String?>? = null, val year: Int? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val premiereDate: DateTime? = null, val isAutomated: Boolean, val seriesName: String? = null)

BookInfoRemoteSearchQuery

@Serializable

data class BookInfoRemoteSearchQuery(val searchInfo: BookInfo? = null, val itemId: UUID, val searchProviderName: String? = null, val includeDisabledProviders: Boolean)

BoxSetInfo

@Serializable

data class BoxSetInfo(val name: String? = null, val originalTitle: String? = null, val path: String? = null, val metadataLanguage: String? = null, val metadataCountryCode: String? = null, val providerIds: Map<String, String?>? = null, val year: Int? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val premiereDate: DateTime? = null, val isAutomated: Boolean)

BoxSetInfoRemoteSearchQuery

@Serializable

data class BoxSetInfoRemoteSearchQuery(val searchInfo: BoxSetInfo? = null, val itemId: UUID, val searchProviderName: String? = null, val includeDisabledProviders: Boolean)

BrandingOptions

@Serializable

data class BrandingOptions(val loginDisclaimer: String? = null, val customCss: String? = null, val splashscreenEnabled: Boolean)

The branding options.

BufferRequestDto

@Serializable

data class BufferRequestDto(val when: DateTime, val positionTicks: Long, val isPlaying: Boolean, val playlistItemId: UUID)

Class BufferRequestDto.

ChannelFeatures

@Serializable

data class ChannelFeatures(val name: String, val id: UUID, val canSearch: Boolean, val mediaTypes: List<ChannelMediaType>, val contentTypes: List<ChannelMediaContentType>, val maxPageSize: Int? = null, val autoRefreshLevels: Int? = null, val defaultSortFields: List<ChannelItemSortField>, val supportsSortOrderToggle: Boolean, val supportsLatestMedia: Boolean, val canFilter: Boolean, val supportsContentDownloading: Boolean)

ChannelItemSortField

@Serializable

enum ChannelItemSortField : Enum<ChannelItemSortField>

ChannelMappingOptionsDto

@Serializable

data class ChannelMappingOptionsDto(val tunerChannels: List<TunerChannelMapping>, val providerChannels: List<NameIdPair>, val mappings: List<NameValuePair>, val providerName: String? = null)

Channel mapping options dto.

ChannelMediaContentType

@Serializable

enum ChannelMediaContentType : Enum<ChannelMediaContentType>

ChannelMediaType

@Serializable

enum ChannelMediaType : Enum<ChannelMediaType>

ChannelType

@Serializable

enum ChannelType : Enum<ChannelType>

Enum ChannelType.

ChapterInfo

@Serializable

data class ChapterInfo(val startPositionTicks: Long, val name: String? = null, val imagePath: String? = null, val imageDateModified: DateTime, val imageTag: String? = null)

Class ChapterInfo.

ClientCapabilities

@Serializable

data class ClientCapabilities(val playableMediaTypes: List<String>? = null, val supportedCommands: List<GeneralCommandType>? = null, val supportsMediaControl: Boolean, val supportsContentUploading: Boolean, val messageCallbackUrl: String? = null, val supportsPersistentIdentifier: Boolean, val supportsSync: Boolean, val deviceProfile: DeviceProfile? = null, val appStoreUrl: String? = null, val iconUrl: String? = null)

ClientCapabilitiesDto

@Serializable

data class ClientCapabilitiesDto(val playableMediaTypes: List<String>, val supportedCommands: List<GeneralCommandType>, val supportsMediaControl: Boolean, val supportsContentUploading: Boolean, val messageCallbackUrl: String? = null, val supportsPersistentIdentifier: Boolean, val supportsSync: Boolean, val deviceProfile: DeviceProfile? = null, val appStoreUrl: String? = null, val iconUrl: String? = null)

Client capabilities dto.

ClientLogDocumentResponseDto

@Serializable

data class ClientLogDocumentResponseDto(val fileName: String)

Client log document response dto.

CodecProfile

@Serializable

data class CodecProfile(val type: CodecType, val conditions: List<ProfileCondition>? = null, val applyConditions: List<ProfileCondition>? = null, val codec: String? = null, val container: String? = null)

CodecType

@Serializable

enum CodecType : Enum<CodecType>

CollectionCreationResult

@Serializable

data class CollectionCreationResult(val id: UUID)

CollectionTypeOptions

@Serializable

enum CollectionTypeOptions : Enum<CollectionTypeOptions>

ConfigImageTypes

@Serializable

data class ConfigImageTypes(val backdropSizes: List<String>? = null, val baseUrl: String? = null, val logoSizes: List<String>? = null, val posterSizes: List<String>? = null, val profileSizes: List<String>? = null, val secureBaseUrl: String? = null, val stillSizes: List<String>? = null)

ConfigurationPageInfo

@Serializable

data class ConfigurationPageInfo(val name: String, val enableInMainMenu: Boolean, val menuSection: String? = null, val menuIcon: String? = null, val displayName: String? = null, val pluginId: UUID? = null)

The configuration page info.

ContainerProfile

@Serializable

data class ContainerProfile(val type: DlnaProfileType, val conditions: List<ProfileCondition>? = null, val container: String)

ControlResponse

@Serializable

data class ControlResponse(val headers: Map<String, String>, val xml: String, val isSuccessful: Boolean)

CountryInfo

@Serializable

data class CountryInfo(val name: String? = null, val displayName: String? = null, val twoLetterIsoRegionName: String? = null, val threeLetterIsoRegionName: String? = null)

Class CountryInfo.

CreatePlaylistDto

@Serializable

data class CreatePlaylistDto(val name: String? = null, val ids: List<UUID>, val userId: UUID? = null, val mediaType: String? = null)

Create new playlist dto.

CreateUserByName

@Serializable

data class CreateUserByName(val name: String? = null, val password: String? = null)

The create user by name request body.

CultureDto

@Serializable

data class CultureDto(val name: String, val displayName: String, val twoLetterIsoLanguageName: String, val threeLetterIsoLanguageName: String? = null, val threeLetterIsoLanguageNames: List<String>)

Class CultureDto.

DayOfWeek

@Serializable

enum DayOfWeek : Enum<DayOfWeek>

DayPattern

@Serializable

enum DayPattern : Enum<DayPattern>

DefaultDirectoryBrowserInfoDto

@Serializable

data class DefaultDirectoryBrowserInfoDto(val path: String? = null)

Default directory browser info.

DeviceIdentification

@Serializable

data class DeviceIdentification(val friendlyName: String, val modelNumber: String, val serialNumber: String, val modelName: String, val modelDescription: String, val modelUrl: String, val manufacturer: String, val manufacturerUrl: String, val headers: List<HttpHeaderInfo>)

DeviceInfo

@Serializable

data class DeviceInfo(val name: String? = null, val accessToken: String? = null, val id: String? = null, val lastUserName: String? = null, val appName: String? = null, val appVersion: String? = null, val lastUserId: UUID, val dateLastActivity: DateTime, val capabilities: ClientCapabilities? = null, val iconUrl: String? = null)

DeviceInfoQueryResult

@Serializable

data class DeviceInfoQueryResult(val items: List<DeviceInfo>? = null, val totalRecordCount: Int, val startIndex: Int)

DeviceOptions

@Serializable

data class DeviceOptions(val id: Int, val deviceId: String, val customName: String? = null)

An entity representing custom options for a device.

DeviceOptionsDto

@Serializable

data class DeviceOptionsDto(val id: Int, val deviceId: String? = null, val customName: String? = null)

A dto representing custom options for a device.

DeviceProfile

@Serializable

data class DeviceProfile(val name: String? = null, val id: String? = null, val identification: DeviceIdentification? = null, val friendlyName: String? = null, val manufacturer: String? = null, val manufacturerUrl: String? = null, val modelName: String? = null, val modelDescription: String? = null, val modelNumber: String? = null, val modelUrl: String? = null, val serialNumber: String? = null, val enableAlbumArtInDidl: Boolean = false, val enableSingleAlbumArtLimit: Boolean = false, val enableSingleSubtitleLimit: Boolean = false, val supportedMediaTypes: String, val userId: String? = null, val albumArtPn: String? = null, val maxAlbumArtWidth: Int? = null, val maxAlbumArtHeight: Int? = null, val maxIconWidth: Int? = null, val maxIconHeight: Int? = null, val maxStreamingBitrate: Int? = null, val maxStaticBitrate: Int? = null, val musicStreamingTranscodingBitrate: Int? = null, val maxStaticMusicBitrate: Int? = null, val sonyAggregationFlags: String? = null, val protocolInfo: String? = null, val timelineOffsetSeconds: Int = 0, val requiresPlainVideoItems: Boolean = false, val requiresPlainFolders: Boolean = false, val enableMsMediaReceiverRegistrar: Boolean = false, val ignoreTranscodeByteRangeRequests: Boolean = false, val xmlRootAttributes: List<XmlAttribute>, val directPlayProfiles: List<DirectPlayProfile>, val transcodingProfiles: List<TranscodingProfile>, val containerProfiles: List<ContainerProfile>, val codecProfiles: List<CodecProfile>, val responseProfiles: List<ResponseProfile>, val subtitleProfiles: List<SubtitleProfile>)

A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play.

DeviceProfileInfo

@Serializable

data class DeviceProfileInfo(val id: String? = null, val name: String? = null, val type: DeviceProfileType)

DeviceProfileType

@Serializable

enum DeviceProfileType : Enum<DeviceProfileType>

DirectPlayProfile

@Serializable

data class DirectPlayProfile(val container: String? = null, val audioCodec: String? = null, val videoCodec: String? = null, val type: DlnaProfileType)

DisplayPreferencesDto

@Serializable

data class DisplayPreferencesDto(val id: String? = null, val viewType: String? = null, val sortBy: String? = null, val indexBy: String? = null, val rememberIndexing: Boolean, val primaryImageHeight: Int, val primaryImageWidth: Int, val customPrefs: Map<String, String?>, val scrollDirection: ScrollDirection, val showBackdrop: Boolean, val rememberSorting: Boolean, val sortOrder: SortOrder, val showSidebar: Boolean, val client: String? = null)

Defines the display preferences for any item that supports them (usually Folders).

DlnaOptions

@Serializable

data class DlnaOptions(val enablePlayTo: Boolean, val enableServer: Boolean, val enableDebugLog: Boolean, val enablePlayToTracing: Boolean, val clientDiscoveryIntervalSeconds: Int, val aliveMessageIntervalSeconds: Int, val blastAliveMessageIntervalSeconds: Int, val defaultUserId: String? = null, val autoCreatePlayToProfiles: Boolean, val blastAliveMessages: Boolean, val sendOnlyMatchedHost: Boolean)

The DlnaOptions class contains the user definable parameters for the dlna subsystems.

DlnaProfileType

@Serializable

enum DlnaProfileType : Enum<DlnaProfileType>

DynamicDayOfWeek

@Serializable

enum DynamicDayOfWeek : Enum<DynamicDayOfWeek>

An enum that represents a day of the week, weekdays, weekends, or all days.

EmbeddedSubtitleOptions

@Serializable

enum EmbeddedSubtitleOptions : Enum<EmbeddedSubtitleOptions>

An enum representing the options to disable embedded subs.

EncodingContext

@Serializable

enum EncodingContext : Enum<EncodingContext>

EncodingOptions

@Serializable

data class EncodingOptions(val encodingThreadCount: Int, val transcodingTempPath: String? = null, val fallbackFontPath: String? = null, val enableFallbackFont: Boolean, val downMixAudioBoost: Double, val maxMuxingQueueSize: Int, val enableThrottling: Boolean, val throttleDelaySeconds: Int, val hardwareAccelerationType: String? = null, val encoderAppPath: String? = null, val encoderAppPathDisplay: String? = null, val vaapiDevice: String? = null, val enableTonemapping: Boolean, val enableVppTonemapping: Boolean, val tonemappingAlgorithm: String? = null, val tonemappingMode: String? = null, val tonemappingRange: String? = null, val tonemappingDesat: Double, val tonemappingPeak: Double, val tonemappingParam: Double, val vppTonemappingBrightness: Double, val vppTonemappingContrast: Double, val h264Crf: Int, val h265Crf: Int, val encoderPreset: String? = null, val deinterlaceDoubleRate: Boolean, val deinterlaceMethod: String? = null, val enableDecodingColorDepth10Hevc: Boolean, val enableDecodingColorDepth10Vp9: Boolean, val enableEnhancedNvdecDecoder: Boolean, val preferSystemNativeHwDecoder: Boolean, val enableIntelLowPowerH264HwEncoder: Boolean, val enableIntelLowPowerHevcHwEncoder: Boolean, val enableHardwareEncoding: Boolean, val allowHevcEncoding: Boolean, val enableSubtitleExtraction: Boolean, val hardwareDecodingCodecs: List<String>? = null, val allowOnDemandMetadataBasedKeyframeExtractionForExtensions: List<String>? = null)

EndPointInfo

@Serializable

data class EndPointInfo(val isLocal: Boolean, val isInNetwork: Boolean)

ExternalIdInfo

@Serializable

data class ExternalIdInfo(val name: String, val key: String, val type: ExternalIdMediaType? = null, val urlFormatString: String? = null)

Represents the external id information for serialization to the client.

ExternalIdMediaType

@Serializable

enum ExternalIdMediaType : Enum<ExternalIdMediaType>

The specific media type of an MediaBrowser.Model.Providers.ExternalIdInfo.

ExternalUrl

@Serializable

data class ExternalUrl(val name: String? = null, val url: String? = null)

FFmpegLocation

@Serializable

enum FFmpegLocation : Enum<FFmpegLocation>

Enum describing the location of the FFmpeg tool.

FileSystemEntryInfo

@Serializable

data class FileSystemEntryInfo(val name: String, val path: String, val type: FileSystemEntryType)

Class FileSystemEntryInfo.

FileSystemEntryType

@Serializable

enum FileSystemEntryType : Enum<FileSystemEntryType>

Enum FileSystemEntryType.

FontFile

@Serializable

data class FontFile(val name: String? = null, val size: Long, val dateCreated: DateTime, val dateModified: DateTime)

Class FontFile.

ForgotPasswordAction

@Serializable

enum ForgotPasswordAction : Enum<ForgotPasswordAction>

ForgotPasswordDto

@Serializable

data class ForgotPasswordDto(val enteredUsername: String)

Forgot Password request body DTO.

ForgotPasswordPinDto

@Serializable

data class ForgotPasswordPinDto(val pin: String)

Forgot Password Pin enter request body DTO.

ForgotPasswordResult

@Serializable

data class ForgotPasswordResult(val action: ForgotPasswordAction, val pinFile: String? = null, val pinExpirationDate: DateTime? = null)

GeneralCommand

@Serializable

data class GeneralCommand(val name: GeneralCommandType, val controllingUserId: UUID, val arguments: Map<String, String?>)

GeneralCommandType

@Serializable

enum GeneralCommandType : Enum<GeneralCommandType>

This exists simply to identify a set of known commands.

GetProgramsDto

@Serializable

data class GetProgramsDto(val channelIds: List<UUID>, val userId: UUID, val minStartDate: DateTime? = null, val hasAired: Boolean? = null, val isAiring: Boolean? = null, val maxStartDate: DateTime? = null, val minEndDate: DateTime? = null, val maxEndDate: DateTime? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val startIndex: Int? = null, val limit: Int? = null, val sortBy: List<String>, val sortOrder: List<SortOrder>, val genres: List<String>, val genreIds: List<UUID>, val enableImages: Boolean? = null, val enableTotalRecordCount: Boolean, val imageTypeLimit: Int? = null, val enableImageTypes: List<ImageType>, val enableUserData: Boolean? = null, val seriesTimerId: String? = null, val librarySeriesId: UUID, val fields: List<ItemFields>)

Get programs dto.

GroupInfoDto

@Serializable

data class GroupInfoDto(val groupId: UUID, val groupName: String, val state: GroupStateType, val participants: List<String>, val lastUpdatedAt: DateTime)

Class GroupInfoDto.

GroupQueueMode

@Serializable

enum GroupQueueMode : Enum<GroupQueueMode>

Enum GroupQueueMode.

GroupRepeatMode

@Serializable

enum GroupRepeatMode : Enum<GroupRepeatMode>

Enum GroupRepeatMode.

GroupShuffleMode

@Serializable

enum GroupShuffleMode : Enum<GroupShuffleMode>

Enum GroupShuffleMode.

GroupStateType

@Serializable

enum GroupStateType : Enum<GroupStateType>

Enum GroupState.

GroupUpdateType

@Serializable

enum GroupUpdateType : Enum<GroupUpdateType>

Enum GroupUpdateType.

GuideInfo

@Serializable

data class GuideInfo(val startDate: DateTime, val endDate: DateTime)

HardwareEncodingType

@Serializable

enum HardwareEncodingType : Enum<HardwareEncodingType>

Enum HardwareEncodingType.

HeaderMatchType

@Serializable

enum HeaderMatchType : Enum<HeaderMatchType>

HttpHeaderInfo

@Serializable

data class HttpHeaderInfo(val name: String? = null, val value: String? = null, val match: HeaderMatchType)

IgnoreWaitRequestDto

@Serializable

data class IgnoreWaitRequestDto(val ignoreWait: Boolean)

Class IgnoreWaitRequestDto.

ImageByNameInfo

@Serializable

data class ImageByNameInfo(val name: String? = null, val theme: String? = null, val context: String? = null, val fileLength: Long, val format: String? = null)

ImageFormat

@Serializable

enum ImageFormat : Enum<ImageFormat>

Enum ImageOutputFormat.

ImageInfo

@Serializable

data class ImageInfo(val imageType: ImageType, val imageIndex: Int? = null, val imageTag: String? = null, val path: String? = null, val blurHash: String? = null, val height: Int? = null, val width: Int? = null, val size: Long)

Class ImageInfo.

ImageOption

@Serializable

data class ImageOption(val type: ImageType, val limit: Int, val minWidth: Int)

ImageOrientation

@Serializable

enum ImageOrientation : Enum<ImageOrientation>

ImageProviderInfo

@Serializable

data class ImageProviderInfo(val name: String, val supportedImages: List<ImageType>)

Class ImageProviderInfo.

ImageSavingConvention

@Serializable

enum ImageSavingConvention : Enum<ImageSavingConvention>

ImageType

@Serializable

enum ImageType : Enum<ImageType>

Enum ImageType.

InstallationInfo

@Serializable

data class InstallationInfo(val guid: UUID, val name: String? = null, val version: String? = null, val changelog: String? = null, val sourceUrl: String? = null, val checksum: String? = null, val packageInfo: PackageInfo? = null)

Class InstallationInfo.

IPlugin

@Serializable

data class IPlugin(val name: String? = null, val description: String? = null, val id: UUID, val version: String? = null, val assemblyFilePath: String? = null, val canUninstall: Boolean, val dataFolderPath: String? = null)

Defines the MediaBrowser.Common.Plugins.IPlugin.

IsoType

@Serializable

enum IsoType : Enum<IsoType>

Enum IsoType.

ItemCounts

@Serializable

data class ItemCounts(val movieCount: Int, val seriesCount: Int, val episodeCount: Int, val artistCount: Int, val programCount: Int, val trailerCount: Int, val songCount: Int, val albumCount: Int, val musicVideoCount: Int, val boxSetCount: Int, val bookCount: Int, val itemCount: Int)

Class LibrarySummary.

ItemFields

@Serializable

enum ItemFields : Enum<ItemFields>

Used to control the data that gets attached to DtoBaseItems.

ItemFilter

@Serializable

enum ItemFilter : Enum<ItemFilter>

Enum ItemFilter.

JoinGroupRequestDto

@Serializable

data class JoinGroupRequestDto(val groupId: UUID)

Class JoinGroupRequestDto.

KeepUntil

@Serializable

enum KeepUntil : Enum<KeepUntil>

LibraryOptionInfoDto

@Serializable

data class LibraryOptionInfoDto(val name: String? = null, val defaultEnabled: Boolean)

Library option info dto.

LibraryOptions

@Serializable

data class LibraryOptions(val enablePhotos: Boolean, val enableRealtimeMonitor: Boolean, val enableChapterImageExtraction: Boolean, val extractChapterImagesDuringLibraryScan: Boolean, val pathInfos: List<MediaPathInfo>, val saveLocalMetadata: Boolean, val enableInternetProviders: Boolean, val enableAutomaticSeriesGrouping: Boolean, val enableEmbeddedTitles: Boolean, val enableEmbeddedEpisodeInfos: Boolean, val automaticRefreshIntervalDays: Int, val preferredMetadataLanguage: String? = null, val metadataCountryCode: String? = null, val seasonZeroDisplayName: String, val metadataSavers: List<String>? = null, val disabledLocalMetadataReaders: List<String>, val localMetadataReaderOrder: List<String>? = null, val disabledSubtitleFetchers: List<String>, val subtitleFetcherOrder: List<String>, val skipSubtitlesIfEmbeddedSubtitlesPresent: Boolean, val skipSubtitlesIfAudioTrackMatches: Boolean, val subtitleDownloadLanguages: List<String>? = null, val requirePerfectSubtitleMatch: Boolean, val saveSubtitlesWithMedia: Boolean, val automaticallyAddToCollection: Boolean, val allowEmbeddedSubtitles: EmbeddedSubtitleOptions, val typeOptions: List<TypeOptions>)

LibraryOptionsResultDto

@Serializable

data class LibraryOptionsResultDto(val metadataSavers: List<LibraryOptionInfoDto>, val metadataReaders: List<LibraryOptionInfoDto>, val subtitleFetchers: List<LibraryOptionInfoDto>, val typeOptions: List<LibraryTypeOptionsDto>)

Library options result dto.

LibraryTypeOptionsDto

@Serializable

data class LibraryTypeOptionsDto(val type: String? = null, val metadataFetchers: List<LibraryOptionInfoDto>, val imageFetchers: List<LibraryOptionInfoDto>, val supportedImageTypes: List<ImageType>, val defaultImageOptions: List<ImageOption>)

Library type options dto.

LibraryUpdateInfo

@Serializable

data class LibraryUpdateInfo(val foldersAddedTo: List<String>, val foldersRemovedFrom: List<String>, val itemsAdded: List<String>, val itemsRemoved: List<String>, val itemsUpdated: List<String>, val collectionFolders: List<String>, val isEmpty: Boolean)

Class LibraryUpdateInfo.

ListingsProviderInfo

@Serializable

data class ListingsProviderInfo(val id: String? = null, val type: String? = null, val username: String? = null, val password: String? = null, val listingsId: String? = null, val zipCode: String? = null, val country: String? = null, val path: String? = null, val enabledTuners: List<String>? = null, val enableAllTuners: Boolean, val newsCategories: List<String>? = null, val sportsCategories: List<String>? = null, val kidsCategories: List<String>? = null, val movieCategories: List<String>? = null, val channelMappings: List<NameValuePair>? = null, val moviePrefix: String? = null, val preferredLanguage: String? = null, val userAgent: String? = null)

LiveStreamResponse

@Serializable

data class LiveStreamResponse(val mediaSource: MediaSourceInfo)

LiveTvInfo

@Serializable

data class LiveTvInfo(val services: List<LiveTvServiceInfo>, val isEnabled: Boolean, val enabledUsers: List<String>)

LiveTvOptions

@Serializable

data class LiveTvOptions(val guideDays: Int? = null, val recordingPath: String? = null, val movieRecordingPath: String? = null, val seriesRecordingPath: String? = null, val enableRecordingSubfolders: Boolean, val enableOriginalAudioWithEncodedRecordings: Boolean, val tunerHosts: List<TunerHostInfo>? = null, val listingProviders: List<ListingsProviderInfo>? = null, val prePaddingSeconds: Int, val postPaddingSeconds: Int, val mediaLocationsCreated: List<String>? = null, val recordingPostProcessor: String? = null, val recordingPostProcessorArguments: String? = null)

LiveTvServiceInfo

@Serializable

data class LiveTvServiceInfo(val name: String? = null, val homePageUrl: String? = null, val status: LiveTvServiceStatus, val statusMessage: String? = null, val version: String? = null, val hasUpdateAvailable: Boolean, val isVisible: Boolean, val tuners: List<String>? = null)

Class ServiceInfo.

LiveTvServiceStatus

@Serializable

enum LiveTvServiceStatus : Enum<LiveTvServiceStatus>

LocalizationOption

@Serializable

data class LocalizationOption(val name: String? = null, val value: String? = null)

LocationType

@Serializable

enum LocationType : Enum<LocationType>

Enum LocationType.

LogFile

@Serializable

data class LogFile(val dateCreated: DateTime, val dateModified: DateTime, val size: Long, val name: String? = null)

LogLevel

@Serializable

enum LogLevel : Enum<LogLevel>

MediaAttachment

@Serializable

data class MediaAttachment(val codec: String? = null, val codecTag: String? = null, val comment: String? = null, val index: Int, val fileName: String? = null, val mimeType: String? = null, val deliveryUrl: String? = null)

Class MediaAttachment.

MediaEncoderPathDto

@Serializable

data class MediaEncoderPathDto(val path: String, val pathType: String)

Media Encoder Path Dto.

MediaPathDto

@Serializable

data class MediaPathDto(val name: String, val path: String? = null, val pathInfo: MediaPathInfo? = null)

Media Path dto.

MediaPathInfo

@Serializable

data class MediaPathInfo(val path: String, val networkPath: String? = null)

MediaProtocol

@Serializable

enum MediaProtocol : Enum<MediaProtocol>

MediaSourceInfo

@Serializable

data class MediaSourceInfo(val protocol: MediaProtocol, val id: String? = null, val path: String? = null, val encoderPath: String? = null, val encoderProtocol: MediaProtocol? = null, val type: MediaSourceType, val container: String? = null, val size: Long? = null, val name: String? = null, val isRemote: Boolean, val eTag: String? = null, val runTimeTicks: Long? = null, val readAtNativeFramerate: Boolean, val ignoreDts: Boolean, val ignoreIndex: Boolean, val genPtsInput: Boolean, val supportsTranscoding: Boolean, val supportsDirectStream: Boolean, val supportsDirectPlay: Boolean, val isInfiniteStream: Boolean, val requiresOpening: Boolean, val openToken: String? = null, val requiresClosing: Boolean, val liveStreamId: String? = null, val bufferMs: Int? = null, val requiresLooping: Boolean, val supportsProbing: Boolean, val videoType: VideoType? = null, val isoType: IsoType? = null, val video3dFormat: Video3dFormat? = null, val mediaStreams: List<MediaStream>? = null, val mediaAttachments: List<MediaAttachment>? = null, val formats: List<String>? = null, val bitrate: Int? = null, val timestamp: TransportStreamTimestamp? = null, val requiredHttpHeaders: Map<String, String?>? = null, val transcodingUrl: String? = null, val transcodingSubProtocol: String? = null, val transcodingContainer: String? = null, val analyzeDurationMs: Int? = null, val defaultAudioStreamIndex: Int? = null, val defaultSubtitleStreamIndex: Int? = null)

MediaSourceType

@Serializable

enum MediaSourceType : Enum<MediaSourceType>

MediaStream

@Serializable

data class MediaStream(val codec: String? = null, val codecTag: String? = null, val language: String? = null, val colorRange: String? = null, val colorSpace: String? = null, val colorTransfer: String? = null, val colorPrimaries: String? = null, val dvVersionMajor: Int? = null, val dvVersionMinor: Int? = null, val dvProfile: Int? = null, val dvLevel: Int? = null, val rpuPresentFlag: Int? = null, val elPresentFlag: Int? = null, val blPresentFlag: Int? = null, val dvBlSignalCompatibilityId: Int? = null, val comment: String? = null, val timeBase: String? = null, val codecTimeBase: String? = null, val title: String? = null, val videoRange: String? = null, val videoRangeType: String? = null, val videoDoViTitle: String? = null, val localizedUndefined: String? = null, val localizedDefault: String? = null, val localizedForced: String? = null, val localizedExternal: String? = null, val displayTitle: String? = null, val nalLengthSize: String? = null, val isInterlaced: Boolean, val isAvc: Boolean? = null, val channelLayout: String? = null, val bitRate: Int? = null, val bitDepth: Int? = null, val refFrames: Int? = null, val packetLength: Int? = null, val channels: Int? = null, val sampleRate: Int? = null, val isDefault: Boolean, val isForced: Boolean, val height: Int? = null, val width: Int? = null, val averageFrameRate: Float? = null, val realFrameRate: Float? = null, val profile: String? = null, val type: MediaStreamType, val aspectRatio: String? = null, val index: Int, val score: Int? = null, val isExternal: Boolean, val deliveryMethod: SubtitleDeliveryMethod? = null, val deliveryUrl: String? = null, val isExternalUrl: Boolean? = null, val isTextSubtitleStream: Boolean, val supportsExternalStream: Boolean, val path: String? = null, val pixelFormat: String? = null, val level: Double? = null, val isAnamorphic: Boolean? = null)

Class MediaStream.

MediaStreamType

@Serializable

enum MediaStreamType : Enum<MediaStreamType>

Enum MediaStreamType.

MediaUpdateInfoDto

@Serializable

data class MediaUpdateInfoDto(val updates: List<MediaUpdateInfoPathDto>)

Media Update Info Dto.

MediaUpdateInfoPathDto

@Serializable

data class MediaUpdateInfoPathDto(val path: String? = null, val updateType: String? = null)

The media update info path.

MediaUrl

@Serializable

data class MediaUrl(val url: String? = null, val name: String? = null)

MessageCommand

@Serializable

data class MessageCommand(val header: String? = null, val text: String, val timeoutMs: Long? = null)

MetadataConfiguration

@Serializable

data class MetadataConfiguration(val useFileCreationTimeForDateAdded: Boolean)

MetadataEditorInfo

@Serializable

data class MetadataEditorInfo(val parentalRatingOptions: List<ParentalRating>, val countries: List<CountryInfo>, val cultures: List<CultureDto>, val externalIdInfos: List<ExternalIdInfo>, val contentType: String? = null, val contentTypeOptions: List<NameValuePair>)

MetadataField

@Serializable

enum MetadataField : Enum<MetadataField>

Enum MetadataFields.

MetadataOptions

@Serializable

data class MetadataOptions(val itemType: String? = null, val disabledMetadataSavers: List<String>? = null, val localMetadataReaderOrder: List<String>? = null, val disabledMetadataFetchers: List<String>? = null, val metadataFetcherOrder: List<String>? = null, val disabledImageFetchers: List<String>? = null, val imageFetcherOrder: List<String>? = null)

Class MetadataOptions.

MetadataRefreshMode

@Serializable

enum MetadataRefreshMode : Enum<MetadataRefreshMode>

MovePlaylistItemRequestDto

@Serializable

data class MovePlaylistItemRequestDto(val playlistItemId: UUID, val newIndex: Int)

Class MovePlaylistItemRequestDto.

MovieInfo

@Serializable

data class MovieInfo(val name: String? = null, val originalTitle: String? = null, val path: String? = null, val metadataLanguage: String? = null, val metadataCountryCode: String? = null, val providerIds: Map<String, String?>? = null, val year: Int? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val premiereDate: DateTime? = null, val isAutomated: Boolean)

MovieInfoRemoteSearchQuery

@Serializable

data class MovieInfoRemoteSearchQuery(val searchInfo: MovieInfo? = null, val itemId: UUID, val searchProviderName: String? = null, val includeDisabledProviders: Boolean)

MusicVideoInfo

@Serializable

data class MusicVideoInfo(val name: String? = null, val originalTitle: String? = null, val path: String? = null, val metadataLanguage: String? = null, val metadataCountryCode: String? = null, val providerIds: Map<String, String?>? = null, val year: Int? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val premiereDate: DateTime? = null, val isAutomated: Boolean, val artists: List<String>? = null)

MusicVideoInfoRemoteSearchQuery

@Serializable

data class MusicVideoInfoRemoteSearchQuery(val searchInfo: MusicVideoInfo? = null, val itemId: UUID, val searchProviderName: String? = null, val includeDisabledProviders: Boolean)

NameGuidPair

@Serializable

data class NameGuidPair(val name: String? = null, val id: UUID)

NameIdPair

@Serializable

data class NameIdPair(val name: String? = null, val id: String? = null)

NameValuePair

@Serializable

data class NameValuePair(val name: String? = null, val value: String? = null)

NetworkConfiguration

@Serializable

data class NetworkConfiguration(val requireHttps: Boolean, val certificatePath: String, val certificatePassword: String, val baseUrl: String, val publicHttpsPort: Int, val httpServerPortNumber: Int, val httpsPortNumber: Int, val enableHttps: Boolean, val publicPort: Int, val uPnPCreateHttpPortMap: Boolean, val udpPortRange: String, val enableIpv6: Boolean, val enableIpv4: Boolean, val enableSsdpTracing: Boolean, val ssdpTracingFilter: String, val udpSendCount: Int, val udpSendDelay: Int, val ignoreVirtualInterfaces: Boolean, val virtualInterfaceNames: String, val gatewayMonitorPeriod: Int, val enableMultiSocketBinding: Boolean, val trustAllIp6Interfaces: Boolean, val hdHomerunPortRange: String, val publishedServerUriBySubnet: List<String>, val autoDiscoveryTracing: Boolean, val autoDiscovery: Boolean, val remoteIpFilter: List<String>, val isRemoteIpFilterBlacklist: Boolean, val enableUPnP: Boolean, val enableRemoteAccess: Boolean, val localNetworkSubnets: List<String>, val localNetworkAddresses: List<String>, val knownProxies: List<String>, val enablePublishedServerUriByRequest: Boolean)

Defines the Jellyfin.Networking.Configuration.NetworkConfiguration.

NewGroupRequestDto

@Serializable

data class NewGroupRequestDto(val groupName: String)

Class NewGroupRequestDto.

NextItemRequestDto

@Serializable

data class NextItemRequestDto(val playlistItemId: UUID)

Class NextItemRequestDto.

NotificationDto

@Serializable

data class NotificationDto(val id: String, val userId: String, val date: DateTime, val isRead: Boolean, val name: String, val description: String, val url: String, val level: NotificationLevel)

The notification DTO.

NotificationLevel

@Serializable

enum NotificationLevel : Enum<NotificationLevel>

NotificationOption

@Serializable

data class NotificationOption(val type: String? = null, val disabledMonitorUsers: List<String>, val sendToUsers: List<String>, val enabled: Boolean, val disabledServices: List<String>, val sendToUserMode: SendToUserType)

NotificationOptions

@Serializable

data class NotificationOptions(val options: List<NotificationOption>? = null)

NotificationResultDto

@Serializable

data class NotificationResultDto(val notifications: List<NotificationDto>, val totalRecordCount: Int)

A list of notifications with the total record count for pagination.

NotificationsSummaryDto

@Serializable

data class NotificationsSummaryDto(val unreadCount: Int, val maxUnreadNotificationLevel: NotificationLevel? = null)

The notification summary DTO.

NotificationTypeInfo

@Serializable

data class NotificationTypeInfo(val type: String? = null, val name: String? = null, val enabled: Boolean, val category: String? = null, val isBasedOnUserEvent: Boolean)

ObjectGroupUpdate

@Serializable

data class ObjectGroupUpdate(val groupId: UUID, val type: GroupUpdateType, val data: JsonElement)

Class GroupUpdate.

OpenLiveStreamDto

@Serializable

data class OpenLiveStreamDto(val openToken: String? = null, val userId: UUID? = null, val playSessionId: String? = null, val maxStreamingBitrate: Int? = null, val startTimeTicks: Long? = null, val audioStreamIndex: Int? = null, val subtitleStreamIndex: Int? = null, val maxAudioChannels: Int? = null, val itemId: UUID? = null, val enableDirectPlay: Boolean? = null, val enableDirectStream: Boolean? = null, val deviceProfile: DeviceProfile? = null, val directPlayProtocols: List<MediaProtocol>)

Open live stream dto.

PackageInfo

@Serializable

data class PackageInfo(val name: String, val description: String, val overview: String, val owner: String, val category: String, val guid: UUID, val versions: List<VersionInfo>, val imageUrl: String? = null)

Class PackageInfo.

ParentalRating

@Serializable

data class ParentalRating(val name: String? = null, val value: Int)

Class ParentalRating.

PathSubstitution

@Serializable

data class PathSubstitution(val from: String, val to: String)

Defines the MediaBrowser.Model.Configuration.PathSubstitution.

PersonLookupInfo

@Serializable

data class PersonLookupInfo(val name: String? = null, val originalTitle: String? = null, val path: String? = null, val metadataLanguage: String? = null, val metadataCountryCode: String? = null, val providerIds: Map<String, String?>? = null, val year: Int? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val premiereDate: DateTime? = null, val isAutomated: Boolean)

PersonLookupInfoRemoteSearchQuery

@Serializable

data class PersonLookupInfoRemoteSearchQuery(val searchInfo: PersonLookupInfo? = null, val itemId: UUID, val searchProviderName: String? = null, val includeDisabledProviders: Boolean)

PingRequestDto

@Serializable

data class PingRequestDto(val ping: Long)

Class PingRequestDto.

PinRedeemResult

@Serializable

data class PinRedeemResult(val success: Boolean, val usersReset: List<String>)

PlayAccess

@Serializable

enum PlayAccess : Enum<PlayAccess>

PlaybackErrorCode

@Serializable

enum PlaybackErrorCode : Enum<PlaybackErrorCode>

PlaybackInfoDto

@Serializable

data class PlaybackInfoDto(val userId: UUID? = null, val maxStreamingBitrate: Int? = null, val startTimeTicks: Long? = null, val audioStreamIndex: Int? = null, val subtitleStreamIndex: Int? = null, val maxAudioChannels: Int? = null, val mediaSourceId: String? = null, val liveStreamId: String? = null, val deviceProfile: DeviceProfile? = null, val enableDirectPlay: Boolean? = null, val enableDirectStream: Boolean? = null, val enableTranscoding: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val autoOpenLiveStream: Boolean? = null)

Plabyback info dto.

PlaybackInfoResponse

@Serializable

data class PlaybackInfoResponse(val mediaSources: List<MediaSourceInfo>, val playSessionId: String? = null, val errorCode: PlaybackErrorCode? = null)

Class PlaybackInfoResponse.

PlaybackProgressInfo

@Serializable

data class PlaybackProgressInfo(val canSeek: Boolean, val item: BaseItemDto? = null, val itemId: UUID, val sessionId: String? = null, val mediaSourceId: String? = null, val audioStreamIndex: Int? = null, val subtitleStreamIndex: Int? = null, val isPaused: Boolean, val isMuted: Boolean, val positionTicks: Long? = null, val playbackStartTimeTicks: Long? = null, val volumeLevel: Int? = null, val brightness: Int? = null, val aspectRatio: String? = null, val playMethod: PlayMethod, val liveStreamId: String? = null, val playSessionId: String? = null, val repeatMode: RepeatMode, val nowPlayingQueue: List<QueueItem>? = null, val playlistItemId: String? = null)

Class PlaybackProgressInfo.

PlaybackStartInfo

@Serializable

data class PlaybackStartInfo(val canSeek: Boolean, val item: BaseItemDto? = null, val itemId: UUID, val sessionId: String? = null, val mediaSourceId: String? = null, val audioStreamIndex: Int? = null, val subtitleStreamIndex: Int? = null, val isPaused: Boolean, val isMuted: Boolean, val positionTicks: Long? = null, val playbackStartTimeTicks: Long? = null, val volumeLevel: Int? = null, val brightness: Int? = null, val aspectRatio: String? = null, val playMethod: PlayMethod, val liveStreamId: String? = null, val playSessionId: String? = null, val repeatMode: RepeatMode, val nowPlayingQueue: List<QueueItem>? = null, val playlistItemId: String? = null)

Class PlaybackStartInfo.

PlaybackStopInfo

@Serializable

data class PlaybackStopInfo(val item: BaseItemDto? = null, val itemId: UUID, val sessionId: String? = null, val mediaSourceId: String? = null, val positionTicks: Long? = null, val liveStreamId: String? = null, val playSessionId: String? = null, val failed: Boolean, val nextMediaType: String? = null, val playlistItemId: String? = null, val nowPlayingQueue: List<QueueItem>? = null)

Class PlaybackStopInfo.

PlayCommand

@Serializable

enum PlayCommand : Enum<PlayCommand>

Enum PlayCommand.

PlayerStateInfo

@Serializable

data class PlayerStateInfo(val positionTicks: Long? = null, val canSeek: Boolean, val isPaused: Boolean, val isMuted: Boolean, val volumeLevel: Int? = null, val audioStreamIndex: Int? = null, val subtitleStreamIndex: Int? = null, val mediaSourceId: String? = null, val playMethod: PlayMethod? = null, val repeatMode: RepeatMode, val liveStreamId: String? = null)

PlaylistCreationResult

@Serializable

data class PlaylistCreationResult(val id: String)

PlayMethod

@Serializable

enum PlayMethod : Enum<PlayMethod>

PlayRequest

@Serializable

data class PlayRequest(val itemIds: List<UUID>? = null, val startPositionTicks: Long? = null, val playCommand: PlayCommand, val controllingUserId: UUID, val subtitleStreamIndex: Int? = null, val audioStreamIndex: Int? = null, val mediaSourceId: String? = null, val startIndex: Int? = null)

Class PlayRequest.

PlayRequestDto

@Serializable

data class PlayRequestDto(val playingQueue: List<UUID>, val playingItemPosition: Int, val startPositionTicks: Long)

Class PlayRequestDto.

PlaystateCommand

@Serializable

enum PlaystateCommand : Enum<PlaystateCommand>

Enum PlaystateCommand.

PlaystateRequest

@Serializable

data class PlaystateRequest(val command: PlaystateCommand, val seekPositionTicks: Long? = null, val controllingUserId: String? = null)

PluginInfo

@Serializable

data class PluginInfo(val name: String, val version: String, val configurationFileName: String? = null, val description: String, val id: UUID, val canUninstall: Boolean, val hasImage: Boolean, val status: PluginStatus)

This is a serializable stub class that is used by the api to provide information about installed plugins.

PluginStatus

@Serializable

enum PluginStatus : Enum<PluginStatus>

Plugin load status.

PreviousItemRequestDto

@Serializable

data class PreviousItemRequestDto(val playlistItemId: UUID)

Class PreviousItemRequestDto.

ProblemDetails

@Serializable

data class ProblemDetails(val type: String? = null, val title: String? = null, val status: Int? = null, val detail: String? = null, val instance: String? = null)

ProfileCondition

@Serializable

data class ProfileCondition(val condition: ProfileConditionType, val property: ProfileConditionValue, val value: String? = null, val isRequired: Boolean)

ProfileConditionType

@Serializable

enum ProfileConditionType : Enum<ProfileConditionType>

ProfileConditionValue

@Serializable

enum ProfileConditionValue : Enum<ProfileConditionValue>

ProgramAudio

@Serializable

enum ProgramAudio : Enum<ProgramAudio>

PublicSystemInfo

@Serializable

data class PublicSystemInfo(val localAddress: String? = null, val serverName: String? = null, val version: String? = null, val productName: String? = null, val operatingSystem: String? = null, val id: String? = null, val startupWizardCompleted: Boolean? = null)

QueryFilters

@Serializable

data class QueryFilters(val genres: List<NameGuidPair>? = null, val tags: List<String>? = null)

QueryFiltersLegacy

@Serializable

data class QueryFiltersLegacy(val genres: List<String>? = null, val tags: List<String>? = null, val officialRatings: List<String>? = null, val years: List<Int>? = null)

QueueItem

@Serializable

data class QueueItem(val id: UUID, val playlistItemId: String? = null)

QueueRequestDto

@Serializable

data class QueueRequestDto(val itemIds: List<UUID>, val mode: GroupQueueMode)

Class QueueRequestDto.

QuickConnectDto

@Serializable

data class QuickConnectDto(val secret: String)

The quick connect request body.

QuickConnectResult

@Serializable

data class QuickConnectResult(val authenticated: Boolean, val secret: String, val code: String, val deviceId: String, val deviceName: String, val appName: String, val appVersion: String, val dateAdded: DateTime)

Stores the state of an quick connect request.

RatingType

@Serializable

enum RatingType : Enum<RatingType>

ReadyRequestDto

@Serializable

data class ReadyRequestDto(val when: DateTime, val positionTicks: Long, val isPlaying: Boolean, val playlistItemId: UUID)

Class ReadyRequest.

RecommendationDto

@Serializable

data class RecommendationDto(val items: List<BaseItemDto>? = null, val recommendationType: RecommendationType, val baselineItemName: String? = null, val categoryId: UUID)

RecommendationType

@Serializable

enum RecommendationType : Enum<RecommendationType>

RecordingStatus

@Serializable

enum RecordingStatus : Enum<RecordingStatus>

RemoteImageInfo

@Serializable

data class RemoteImageInfo(val providerName: String? = null, val url: String? = null, val thumbnailUrl: String? = null, val height: Int? = null, val width: Int? = null, val communityRating: Double? = null, val voteCount: Int? = null, val language: String? = null, val type: ImageType, val ratingType: RatingType)

Class RemoteImageInfo.

RemoteImageResult

@Serializable

data class RemoteImageResult(val images: List<RemoteImageInfo>? = null, val totalRecordCount: Int, val providers: List<String>? = null)

Class RemoteImageResult.

RemoteSearchResult

@Serializable

data class RemoteSearchResult(val name: String? = null, val providerIds: Map<String, String?>? = null, val productionYear: Int? = null, val indexNumber: Int? = null, val indexNumberEnd: Int? = null, val parentIndexNumber: Int? = null, val premiereDate: DateTime? = null, val imageUrl: String? = null, val searchProviderName: String? = null, val overview: String? = null, val albumArtist: RemoteSearchResult? = null, val artists: List<RemoteSearchResult>? = null)

RemoteSubtitleInfo

@Serializable

data class RemoteSubtitleInfo(val threeLetterIsoLanguageName: String? = null, val id: String? = null, val providerName: String? = null, val name: String? = null, val format: String? = null, val author: String? = null, val comment: String? = null, val dateCreated: DateTime? = null, val communityRating: Float? = null, val downloadCount: Int? = null, val isHashMatch: Boolean? = null)

RemoveFromPlaylistRequestDto

@Serializable

data class RemoveFromPlaylistRequestDto(val playlistItemIds: List<UUID>, val clearPlaylist: Boolean, val clearPlayingItem: Boolean)

Class RemoveFromPlaylistRequestDto.

RepeatMode

@Serializable

enum RepeatMode : Enum<RepeatMode>

RepositoryInfo

@Serializable

data class RepositoryInfo(val name: String? = null, val url: String? = null, val enabled: Boolean)

Class RepositoryInfo.

ResponseProfile

@Serializable

data class ResponseProfile(val container: String? = null, val audioCodec: String? = null, val videoCodec: String? = null, val type: DlnaProfileType, val orgPn: String? = null, val mimeType: String? = null, val conditions: List<ProfileCondition>? = null)

ScrollDirection

@Serializable

enum ScrollDirection : Enum<ScrollDirection>

An enum representing the axis that should be scrolled.

SearchHint

@Serializable

data class SearchHint(val itemId: UUID, val id: UUID, val name: String? = null, val matchedTerm: String? = null, val indexNumber: Int? = null, val productionYear: Int? = null, val parentIndexNumber: Int? = null, val primaryImageTag: String? = null, val thumbImageTag: String? = null, val thumbImageItemId: String? = null, val backdropImageTag: String? = null, val backdropImageItemId: String? = null, val type: String? = null, val isFolder: Boolean? = null, val runTimeTicks: Long? = null, val mediaType: String? = null, val startDate: DateTime? = null, val endDate: DateTime? = null, val series: String? = null, val status: String? = null, val album: String? = null, val albumId: UUID, val albumArtist: String? = null, val artists: List<String>? = null, val songCount: Int? = null, val episodeCount: Int? = null, val channelId: UUID, val channelName: String? = null, val primaryImageAspectRatio: Double? = null)

Class SearchHintResult.

SearchHintResult

@Serializable

data class SearchHintResult(val searchHints: List<SearchHint>, val totalRecordCount: Int)

Class SearchHintResult.

SeekRequestDto

@Serializable

data class SeekRequestDto(val positionTicks: Long)

Class SeekRequestDto.

SendCommand

@Serializable

data class SendCommand(val groupId: UUID, val playlistItemId: UUID, val when: DateTime, val positionTicks: Long? = null, val command: SendCommandType, val emittedAt: DateTime)

Class SendCommand.

SendCommandType

@Serializable

enum SendCommandType : Enum<SendCommandType>

Enum SendCommandType.

SendToUserType

@Serializable

enum SendToUserType : Enum<SendToUserType>

SeriesInfo

@Serializable

data class SeriesInfo(val name: String? = null, val originalTitle: String? = null, val path: String? = null, val metadataLanguage: String? = null, val metadataCountryCode: String? = null, val providerIds: Map<String, String?>? = null, val year: Int? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val premiereDate: DateTime? = null, val isAutomated: Boolean)

SeriesInfoRemoteSearchQuery

@Serializable

data class SeriesInfoRemoteSearchQuery(val searchInfo: SeriesInfo? = null, val itemId: UUID, val searchProviderName: String? = null, val includeDisabledProviders: Boolean)

SeriesStatus

@Serializable

enum SeriesStatus : Enum<SeriesStatus>

Enum SeriesStatus.

SeriesTimerInfoDto

@Serializable

data class SeriesTimerInfoDto(val id: String? = null, val type: String? = null, val serverId: String? = null, val externalId: String? = null, val channelId: UUID, val externalChannelId: String? = null, val channelName: String? = null, val channelPrimaryImageTag: String? = null, val programId: String? = null, val externalProgramId: String? = null, val name: String? = null, val overview: String? = null, val startDate: DateTime, val endDate: DateTime, val serviceName: String? = null, val priority: Int, val prePaddingSeconds: Int, val postPaddingSeconds: Int, val isPrePaddingRequired: Boolean, val parentBackdropItemId: String? = null, val parentBackdropImageTags: List<String>? = null, val isPostPaddingRequired: Boolean, val keepUntil: KeepUntil, val recordAnyTime: Boolean, val skipEpisodesInLibrary: Boolean, val recordAnyChannel: Boolean, val keepUpTo: Int, val recordNewOnly: Boolean, val days: List<DayOfWeek>? = null, val dayPattern: DayPattern? = null, val imageTags: Map<ImageType, String>? = null, val parentThumbItemId: String? = null, val parentThumbImageTag: String? = null, val parentPrimaryImageItemId: String? = null, val parentPrimaryImageTag: String? = null)

Class SeriesTimerInfoDto.

SeriesTimerInfoDtoQueryResult

@Serializable

data class SeriesTimerInfoDtoQueryResult(val items: List<SeriesTimerInfoDto>? = null, val totalRecordCount: Int, val startIndex: Int)

ServerConfiguration

@Serializable

data class ServerConfiguration(val logFileRetentionDays: Int, val isStartupWizardCompleted: Boolean, val cachePath: String? = null, val previousVersion: String? = null, val previousVersionStr: String? = null, val enableMetrics: Boolean, val enableNormalizedItemByNameIds: Boolean, val isPortAuthorized: Boolean, val quickConnectAvailable: Boolean, val enableCaseSensitiveItemIds: Boolean, val disableLiveTvChannelUserDataName: Boolean, val metadataPath: String, val metadataNetworkPath: String, val preferredMetadataLanguage: String, val metadataCountryCode: String, val sortReplaceCharacters: List<String>, val sortRemoveCharacters: List<String>, val sortRemoveWords: List<String>, val minResumePct: Int, val maxResumePct: Int, val minResumeDurationSeconds: Int, val minAudiobookResume: Int, val maxAudiobookResume: Int, val libraryMonitorDelay: Int, val imageSavingConvention: ImageSavingConvention, val metadataOptions: List<MetadataOptions>, val skipDeserializationForBasicTypes: Boolean, val serverName: String, val uiCulture: String, val saveMetadataHidden: Boolean, val contentTypes: List<NameValuePair>, val remoteClientBitrateLimit: Int, val enableFolderView: Boolean, val enableGroupingIntoCollections: Boolean, val displaySpecialsWithinSeasons: Boolean, val codecsUsed: List<String>, val pluginRepositories: List<RepositoryInfo>, val enableExternalContentInSuggestions: Boolean, val imageExtractionTimeoutMs: Int, val pathSubstitutions: List<PathSubstitution>, val enableSlowResponseWarning: Boolean, val slowResponseThresholdMs: Long, val corsHosts: List<String>, val activityLogRetentionDays: Int? = null, val libraryScanFanoutConcurrency: Int, val libraryMetadataRefreshConcurrency: Int, val removeOldPlugins: Boolean, val allowClientLogUpload: Boolean)

Represents the server configuration.

ServerDiscoveryInfo

@Serializable

data class ServerDiscoveryInfo(val address: String, val id: String, val name: String, val endpointAddress: String? = null)

The server discovery info model.

SessionInfo

@Serializable

data class SessionInfo(val playState: PlayerStateInfo? = null, val additionalUsers: List<SessionUserInfo>? = null, val capabilities: ClientCapabilities? = null, val remoteEndPoint: String? = null, val playableMediaTypes: List<String>? = null, val id: String? = null, val userId: UUID, val userName: String? = null, val client: String? = null, val lastActivityDate: DateTime, val lastPlaybackCheckIn: DateTime, val deviceName: String? = null, val deviceType: String? = null, val nowPlayingItem: BaseItemDto? = null, val fullNowPlayingItem: BaseItem? = null, val nowViewingItem: BaseItemDto? = null, val deviceId: String? = null, val applicationVersion: String? = null, val transcodingInfo: TranscodingInfo? = null, val isActive: Boolean, val supportsMediaControl: Boolean, val supportsRemoteControl: Boolean, val nowPlayingQueue: List<QueueItem>? = null, val nowPlayingQueueFullItems: List<BaseItemDto>? = null, val hasCustomDeviceName: Boolean, val playlistItemId: String? = null, val serverId: String? = null, val userPrimaryImageTag: String? = null, val supportedCommands: List<GeneralCommandType>? = null)

Class SessionInfo.

SessionMessageType

@Serializable

enum SessionMessageType : Enum<SessionMessageType>

The different kinds of messages that are used in the WebSocket api.

SessionUserInfo

@Serializable

data class SessionUserInfo(val userId: UUID, val userName: String? = null)

Class SessionUserInfo.

SetChannelMappingDto

@Serializable

data class SetChannelMappingDto(val providerId: String, val tunerChannelId: String, val providerChannelId: String)

Set channel mapping dto.

SetPlaylistItemRequestDto

@Serializable

data class SetPlaylistItemRequestDto(val playlistItemId: UUID)

Class SetPlaylistItemRequestDto.

SetRepeatModeRequestDto

@Serializable

data class SetRepeatModeRequestDto(val mode: GroupRepeatMode)

Class SetRepeatModeRequestDto.

SetShuffleModeRequestDto

@Serializable

data class SetShuffleModeRequestDto(val mode: GroupShuffleMode)

Class SetShuffleModeRequestDto.

SongInfo

@Serializable

data class SongInfo(val name: String? = null, val originalTitle: String? = null, val path: String? = null, val metadataLanguage: String? = null, val metadataCountryCode: String? = null, val providerIds: Map<String, String?>? = null, val year: Int? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val premiereDate: DateTime? = null, val isAutomated: Boolean, val albumArtists: List<String>? = null, val album: String? = null, val artists: List<String>? = null)

SortOrder

@Serializable

enum SortOrder : Enum<SortOrder>

An enum representing the sorting order.

SpecialViewOptionDto

@Serializable

data class SpecialViewOptionDto(val name: String? = null, val id: String? = null)

Special view option dto.

StartupConfigurationDto

@Serializable

data class StartupConfigurationDto(val uiCulture: String? = null, val metadataCountryCode: String? = null, val preferredMetadataLanguage: String? = null)

The startup configuration DTO.

StartupRemoteAccessDto

@Serializable

data class StartupRemoteAccessDto(val enableRemoteAccess: Boolean, val enableAutomaticPortMapping: Boolean)

Startup remote access dto.

StartupUserDto

@Serializable

data class StartupUserDto(val name: String? = null, val password: String? = null)

The startup user DTO.

SubtitleDeliveryMethod

@Serializable

enum SubtitleDeliveryMethod : Enum<SubtitleDeliveryMethod>

Delivery method to use during playback of a specific subtitle format.

SubtitleOptions

@Serializable

data class SubtitleOptions(val skipIfEmbeddedSubtitlesPresent: Boolean, val skipIfAudioTrackMatches: Boolean, val downloadLanguages: List<String>? = null, val downloadMovieSubtitles: Boolean, val downloadEpisodeSubtitles: Boolean, val openSubtitlesUsername: String? = null, val openSubtitlesPasswordHash: String? = null, val isOpenSubtitleVipAccount: Boolean, val requirePerfectMatch: Boolean)

SubtitlePlaybackMode

@Serializable

enum SubtitlePlaybackMode : Enum<SubtitlePlaybackMode>

An enum representing a subtitle playback mode.

SubtitleProfile

@Serializable

data class SubtitleProfile(val format: String? = null, val method: SubtitleDeliveryMethod, val didlMode: String? = null, val language: String? = null, val container: String? = null)

SyncPlayUserAccessType

@Serializable

enum SyncPlayUserAccessType : Enum<SyncPlayUserAccessType>

Enum SyncPlayUserAccessType.

SystemInfo

@Serializable

data class SystemInfo(val localAddress: String? = null, val serverName: String? = null, val version: String? = null, val productName: String? = null, val operatingSystem: String? = null, val id: String? = null, val startupWizardCompleted: Boolean? = null, val operatingSystemDisplayName: String? = null, val packageName: String? = null, val hasPendingRestart: Boolean, val isShuttingDown: Boolean, val supportsLibraryMonitor: Boolean, val webSocketPortNumber: Int, val completedInstallations: List<InstallationInfo>? = null, val canSelfRestart: Boolean, val canLaunchWebBrowser: Boolean, val programDataPath: String? = null, val webPath: String? = null, val itemsByNamePath: String? = null, val cachePath: String? = null, val logPath: String? = null, val internalMetadataPath: String? = null, val transcodingTempPath: String? = null, val hasUpdateAvailable: Boolean, val encoderLocation: FFmpegLocation, val systemArchitecture: Architecture)

Class SystemInfo.

TaskCompletionStatus

@Serializable

enum TaskCompletionStatus : Enum<TaskCompletionStatus>

Enum TaskCompletionStatus.

TaskInfo

@Serializable

data class TaskInfo(val name: String? = null, val state: TaskState, val currentProgressPercentage: Double? = null, val id: String? = null, val lastExecutionResult: TaskResult? = null, val triggers: List<TaskTriggerInfo>? = null, val description: String? = null, val category: String? = null, val isHidden: Boolean, val key: String? = null)

Class TaskInfo.

TaskResult

@Serializable

data class TaskResult(val startTimeUtc: DateTime, val endTimeUtc: DateTime, val status: TaskCompletionStatus, val name: String? = null, val key: String? = null, val id: String? = null, val errorMessage: String? = null, val longErrorMessage: String? = null)

Class TaskExecutionInfo.

TaskState

@Serializable

enum TaskState : Enum<TaskState>

Enum TaskState.

TaskTriggerInfo

@Serializable

data class TaskTriggerInfo(val type: String? = null, val timeOfDayTicks: Long? = null, val intervalTicks: Long? = null, val dayOfWeek: DayOfWeek? = null, val maxRuntimeTicks: Long? = null)

Class TaskTriggerInfo.

ThemeMediaResult

@Serializable

data class ThemeMediaResult(val items: List<BaseItemDto>? = null, val totalRecordCount: Int, val startIndex: Int, val ownerId: UUID)

Class ThemeMediaResult.

TimerEventInfo

@Serializable

data class TimerEventInfo(val id: String, val programId: UUID? = null)

TimerInfoDto

@Serializable

data class TimerInfoDto(val id: String? = null, val type: String? = null, val serverId: String? = null, val externalId: String? = null, val channelId: UUID, val externalChannelId: String? = null, val channelName: String? = null, val channelPrimaryImageTag: String? = null, val programId: String? = null, val externalProgramId: String? = null, val name: String? = null, val overview: String? = null, val startDate: DateTime, val endDate: DateTime, val serviceName: String? = null, val priority: Int, val prePaddingSeconds: Int, val postPaddingSeconds: Int, val isPrePaddingRequired: Boolean, val parentBackdropItemId: String? = null, val parentBackdropImageTags: List<String>? = null, val isPostPaddingRequired: Boolean, val keepUntil: KeepUntil, val status: RecordingStatus, val seriesTimerId: String? = null, val externalSeriesTimerId: String? = null, val runTimeTicks: Long? = null, val programInfo: BaseItemDto? = null)

TimerInfoDtoQueryResult

@Serializable

data class TimerInfoDtoQueryResult(val items: List<TimerInfoDto>? = null, val totalRecordCount: Int, val startIndex: Int)

TrailerInfo

@Serializable

data class TrailerInfo(val name: String? = null, val originalTitle: String? = null, val path: String? = null, val metadataLanguage: String? = null, val metadataCountryCode: String? = null, val providerIds: Map<String, String?>? = null, val year: Int? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val premiereDate: DateTime? = null, val isAutomated: Boolean)

TrailerInfoRemoteSearchQuery

@Serializable

data class TrailerInfoRemoteSearchQuery(val searchInfo: TrailerInfo? = null, val itemId: UUID, val searchProviderName: String? = null, val includeDisabledProviders: Boolean)

TranscodeReason

@Serializable

enum TranscodeReason : Enum<TranscodeReason>

TranscodeSeekInfo

@Serializable

enum TranscodeSeekInfo : Enum<TranscodeSeekInfo>

TranscodingInfo

@Serializable

data class TranscodingInfo(val audioCodec: String? = null, val videoCodec: String? = null, val container: String? = null, val isVideoDirect: Boolean, val isAudioDirect: Boolean, val bitrate: Int? = null, val framerate: Float? = null, val completionPercentage: Double? = null, val width: Int? = null, val height: Int? = null, val audioChannels: Int? = null, val hardwareAccelerationType: HardwareEncodingType? = null, val transcodeReasons: List<TranscodeReason>)

TranscodingProfile

@Serializable

data class TranscodingProfile(val container: String, val type: DlnaProfileType, val videoCodec: String, val audioCodec: String, val protocol: String, val estimateContentLength: Boolean = false, val enableMpegtsM2TsMode: Boolean = false, val transcodeSeekInfo: TranscodeSeekInfo = TranscodeSeekInfo.AUTO, val copyTimestamps: Boolean = false, val context: EncodingContext = EncodingContext.STREAMING, val enableSubtitlesInManifest: Boolean = false, val maxAudioChannels: String? = null, val minSegments: Int = 0, val segmentLength: Int = 0, val breakOnNonKeyFrames: Boolean = false, val conditions: List<ProfileCondition>)

TransportStreamTimestamp

@Serializable

enum TransportStreamTimestamp : Enum<TransportStreamTimestamp>

TunerChannelMapping

@Serializable

data class TunerChannelMapping(val name: String? = null, val providerChannelName: String? = null, val providerChannelId: String? = null, val id: String? = null)

TunerHostInfo

@Serializable

data class TunerHostInfo(val id: String? = null, val url: String? = null, val type: String? = null, val deviceId: String? = null, val friendlyName: String? = null, val importFavoritesOnly: Boolean, val allowHwTranscoding: Boolean, val enableStreamLooping: Boolean, val source: String? = null, val tunerCount: Int, val userAgent: String? = null)

TypeOptions

@Serializable

data class TypeOptions(val type: String? = null, val metadataFetchers: List<String>? = null, val metadataFetcherOrder: List<String>? = null, val imageFetchers: List<String>? = null, val imageFetcherOrder: List<String>? = null, val imageOptions: List<ImageOption>? = null)

UnratedItem

@Serializable

enum UnratedItem : Enum<UnratedItem>

An enum representing an unrated item.

UpdateLibraryOptionsDto

@Serializable

data class UpdateLibraryOptionsDto(val id: UUID, val libraryOptions: LibraryOptions? = null)

Update library options dto.

UpdateMediaPathRequestDto

@Serializable

data class UpdateMediaPathRequestDto(val name: String, val pathInfo: MediaPathInfo)

Update library options dto.

UpdateUserEasyPassword

@Serializable

data class UpdateUserEasyPassword(val newPassword: String? = null, val newPw: String? = null, val resetPassword: Boolean)

The update user easy password request body.

UpdateUserPassword

@Serializable

data class UpdateUserPassword(val currentPassword: String? = null, val currentPw: String? = null, val newPw: String? = null, val resetPassword: Boolean)

The update user password request body.

UploadSubtitleDto

@Serializable

data class UploadSubtitleDto(val language: String, val format: String, val isForced: Boolean, val data: String)

Upload subtitles dto.

UserConfiguration

@Serializable

data class UserConfiguration(val audioLanguagePreference: String? = null, val playDefaultAudioTrack: Boolean, val subtitleLanguagePreference: String? = null, val displayMissingEpisodes: Boolean, val groupedFolders: List<String>, val subtitleMode: SubtitlePlaybackMode, val displayCollectionsView: Boolean, val enableLocalPassword: Boolean, val orderedViews: List<String>, val latestItemsExcludes: List<String>, val myMediaExcludes: List<String>, val hidePlayedInLatest: Boolean, val rememberAudioSelections: Boolean, val rememberSubtitleSelections: Boolean, val enableNextEpisodeAutoPlay: Boolean)

Class UserConfiguration.

UserDto

@Serializable

data class UserDto(val name: String? = null, val serverId: String? = null, val serverName: String? = null, val id: UUID, val primaryImageTag: String? = null, val hasPassword: Boolean, val hasConfiguredPassword: Boolean, val hasConfiguredEasyPassword: Boolean, val enableAutoLogin: Boolean? = null, val lastLoginDate: DateTime? = null, val lastActivityDate: DateTime? = null, val configuration: UserConfiguration? = null, val policy: UserPolicy? = null, val primaryImageAspectRatio: Double? = null)

Class UserDto.

UserItemDataDto

@Serializable

data class UserItemDataDto(val rating: Double? = null, val playedPercentage: Double? = null, val unplayedItemCount: Int? = null, val playbackPositionTicks: Long, val playCount: Int, val isFavorite: Boolean, val likes: Boolean? = null, val lastPlayedDate: DateTime? = null, val played: Boolean, val key: String? = null, val itemId: String? = null)

Class UserItemDataDto.

UserPolicy

@Serializable

data class UserPolicy(val isAdministrator: Boolean, val isHidden: Boolean, val isDisabled: Boolean, val maxParentalRating: Int? = null, val blockedTags: List<String>? = null, val enableUserPreferenceAccess: Boolean, val accessSchedules: List<AccessSchedule>? = null, val blockUnratedItems: List<UnratedItem>? = null, val enableRemoteControlOfOtherUsers: Boolean, val enableSharedDeviceControl: Boolean, val enableRemoteAccess: Boolean, val enableLiveTvManagement: Boolean, val enableLiveTvAccess: Boolean, val enableMediaPlayback: Boolean, val enableAudioPlaybackTranscoding: Boolean, val enableVideoPlaybackTranscoding: Boolean, val enablePlaybackRemuxing: Boolean, val forceRemoteSourceTranscoding: Boolean, val enableContentDeletion: Boolean, val enableContentDeletionFromFolders: List<String>? = null, val enableContentDownloading: Boolean, val enableSyncTranscoding: Boolean, val enableMediaConversion: Boolean, val enabledDevices: List<String>? = null, val enableAllDevices: Boolean, val enabledChannels: List<UUID>? = null, val enableAllChannels: Boolean, val enabledFolders: List<UUID>? = null, val enableAllFolders: Boolean, val invalidLoginAttemptCount: Int, val loginAttemptsBeforeLockout: Int, val maxActiveSessions: Int, val enablePublicSharing: Boolean, val blockedMediaFolders: List<UUID>? = null, val blockedChannels: List<UUID>? = null, val remoteClientBitrateLimit: Int, val authenticationProviderId: String? = null, val passwordResetProviderId: String? = null, val syncPlayAccess: SyncPlayUserAccessType)

UtcTimeResponse

@Serializable

data class UtcTimeResponse(val requestReceptionTime: DateTime, val responseTransmissionTime: DateTime)

Class UtcTimeResponse.

ValidatePathDto

@Serializable

data class ValidatePathDto(val validateWritable: Boolean, val path: String? = null, val isFile: Boolean? = null)

Validate path object.

VersionInfo

@Serializable

data class VersionInfo(val version: String, val versionNumber: String, val changelog: String? = null, val targetAbi: String? = null, val sourceUrl: String? = null, val checksum: String? = null, val timestamp: String? = null, val repositoryName: String, val repositoryUrl: String)

Defines the MediaBrowser.Model.Updates.VersionInfo class.

Video3dFormat

@Serializable

enum Video3dFormat : Enum<Video3dFormat>

VideoType

@Serializable

enum VideoType : Enum<VideoType>

Enum VideoType.

VirtualFolderInfo

@Serializable

data class VirtualFolderInfo(val name: String? = null, val locations: List<String>? = null, val collectionType: CollectionTypeOptions? = null, val libraryOptions: LibraryOptions? = null, val itemId: String? = null, val primaryImageItemId: String? = null, val refreshProgress: Double? = null, val refreshStatus: String? = null)

Used to hold information about a user's list of configured virtual folders.

WakeOnLanInfo

@Serializable

data class WakeOnLanInfo(val macAddress: String? = null, val port: Int)

Provides the MAC address and port for wake-on-LAN functionality.

XbmcMetadataOptions

@Serializable

data class XbmcMetadataOptions(val userId: String? = null, val releaseDateFormat: String, val saveImagePathsInNfo: Boolean, val enablePathSubstitution: Boolean, val enableExtraThumbsDuplication: Boolean)

XmlAttribute

@Serializable

data class XmlAttribute(val name: String? = null, val value: String? = null)

Defines the MediaBrowser.Model.Dlna.XmlAttribute.