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

Package-level declarations

Types

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

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.

ActivityLogEntryMessage

data class ActivityLogEntryMessage(val data: List<ActivityLogEntry>? = null, val messageId: UUID) : OutboundWebSocketMessage

Activity log created message.

ActivityLogEntryQueryResult

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

ActivityLogEntryStartMessage

data class ActivityLogEntryStartMessage(val data: String? = null) : InboundWebSocketMessage

Activity log entry start message. Data is the timing data encoded as "$initialDelay,$interval" in ms.

ActivityLogEntryStopMessage

class ActivityLogEntryStopMessage : InboundWebSocketMessage

Activity log entry stop message.

AddVirtualFolderDto

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

Add virtual folder dto.

AlbumInfo

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

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

AllThemeMediaResult

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

ArtistInfo

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

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

AudioSpatialFormat

enum AudioSpatialFormat : Enum<AudioSpatialFormat>

An enum representing formats of spatial audio.

AuthenticateUserByName

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

The authenticate user by name request body.

AuthenticationInfo

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

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

AuthenticationResult

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

BaseItemDto

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: ExtraType? = null, val airsBeforeSeasonNumber: Int? = null, val airsAfterSeasonNumber: Int? = null, val airsBeforeEpisodeNumber: Int? = null, val canDelete: Boolean? = null, val canDownload: Boolean? = null, val hasLyrics: Boolean? = null, val hasSubtitles: Boolean? = null, val preferredMetadataLanguage: String? = null, val preferredMetadataCountryCode: String? = 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: CollectionType? = 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 trickplay: Map<String, Map<String, TrickplayInfo>>? = null, val locationType: LocationType? = null, val isoType: IsoType? = null, val mediaType: MediaType, 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 normalizationGain: Float? = 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

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

BaseItemKind

enum BaseItemKind : Enum<BaseItemKind>

The base item kind.

BaseItemPerson

data class BaseItemPerson(val name: String? = null, val id: UUID, val role: String? = null, val type: PersonKind, 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

class BasePluginConfiguration

Class BasePluginConfiguration.

BookInfo

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

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

BoxSetInfo

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

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

BrandingOptions

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

The branding options.

BufferRequestDto

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

Class BufferRequestDto.

CastReceiverApplication

data class CastReceiverApplication(val id: String, val name: String)

The cast receiver application model.

ChannelFeatures

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

enum ChannelItemSortField : Enum<ChannelItemSortField>

ChannelMappingOptionsDto

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

Channel mapping options dto.

ChannelMediaContentType

enum ChannelMediaContentType : Enum<ChannelMediaContentType>

ChannelMediaType

enum ChannelMediaType : Enum<ChannelMediaType>

ChannelType

enum ChannelType : Enum<ChannelType>

Enum ChannelType.

ChapterInfo

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

Class ChapterInfo.

ClientCapabilities

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

ClientCapabilitiesDto

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

Client capabilities dto.

ClientLogDocumentResponseDto

data class ClientLogDocumentResponseDto(val fileName: String)

Client log document response dto.

CodecProfile

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

enum CodecType : Enum<CodecType>

CollectionCreationResult

data class CollectionCreationResult(val id: UUID)

CollectionType

enum CollectionType : Enum<CollectionType>

Collection type.

CollectionTypeOptions

enum CollectionTypeOptions : Enum<CollectionTypeOptions>

The collection type options.

ConfigImageTypes

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

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

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

CountryInfo

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

Class CountryInfo.

CreatePlaylistDto

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

Create new playlist dto.

CreateUserByName

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

The create user by name request body.

CultureDto

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

Class CultureDto.

DayOfWeek

enum DayOfWeek : Enum<DayOfWeek>

DayPattern

enum DayPattern : Enum<DayPattern>

DefaultDirectoryBrowserInfoDto

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

Default directory browser info.

DeviceInfo

data class DeviceInfo(val name: String? = null, val customName: 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

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

DeviceOptions

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

An entity representing custom options for a device.

DeviceOptionsDto

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

A dto representing custom options for a device.

DeviceProfile

data class DeviceProfile(val name: String? = null, val id: String? = null, val maxStreamingBitrate: Int? = null, val maxStaticBitrate: Int? = null, val musicStreamingTranscodingBitrate: Int? = null, val maxStaticMusicBitrate: Int? = null, val directPlayProfiles: List<DirectPlayProfile>, val transcodingProfiles: List<TranscodingProfile>, val containerProfiles: List<ContainerProfile>, val codecProfiles: List<CodecProfile>, 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.

DirectPlayProfile

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

DisplayPreferencesDto

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).

DlnaProfileType

enum DlnaProfileType : Enum<DlnaProfileType>

DownMixStereoAlgorithms

enum DownMixStereoAlgorithms : Enum<DownMixStereoAlgorithms>

An enum representing an algorithm to downmix 6ch+ to stereo. Algorithms sourced from https://superuser.com/questions/852400/properly-downmix-5-1-to-stereo-using-ffmpeg/1410620#1410620.

DynamicDayOfWeek

enum DynamicDayOfWeek : Enum<DynamicDayOfWeek>

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

EmbeddedSubtitleOptions

enum EmbeddedSubtitleOptions : Enum<EmbeddedSubtitleOptions>

An enum representing the options to disable embedded subs.

EncodingContext

enum EncodingContext : Enum<EncodingContext>

EncodingOptions

data class EncodingOptions(val encodingThreadCount: Int, val transcodingTempPath: String? = null, val fallbackFontPath: String? = null, val enableFallbackFont: Boolean, val enableAudioVbr: Boolean, val downMixAudioBoost: Double, val downMixStereoAlgorithm: DownMixStereoAlgorithms, val maxMuxingQueueSize: Int, val enableThrottling: Boolean, val throttleDelaySeconds: Int, val enableSegmentDeletion: Boolean, val segmentKeepSeconds: Int, val hardwareAccelerationType: String? = null, val encoderAppPath: String? = null, val encoderAppPathDisplay: String? = null, val vaapiDevice: String? = null, val enableTonemapping: Boolean, val enableVppTonemapping: Boolean, val enableVideoToolboxTonemapping: 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 allowAv1Encoding: Boolean, val enableSubtitleExtraction: Boolean, val hardwareDecodingCodecs: List<String>? = null, val allowOnDemandMetadataBasedKeyframeExtractionForExtensions: List<String>? = null)

Class EncodingOptions.

EndPointInfo

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

ExternalIdInfo

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

enum ExternalIdMediaType : Enum<ExternalIdMediaType>

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

ExternalUrl

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

ExtraType

enum ExtraType : Enum<ExtraType>

FileSystemEntryInfo

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

Class FileSystemEntryInfo.

FileSystemEntryType

enum FileSystemEntryType : Enum<FileSystemEntryType>

Enum FileSystemEntryType.

FontFile

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

Class FontFile.

ForceKeepAliveMessage

data class ForceKeepAliveMessage(val data: Int, val messageId: UUID) : OutboundWebSocketMessage

Force keep alive websocket messages.

ForgotPasswordAction

enum ForgotPasswordAction : Enum<ForgotPasswordAction>

ForgotPasswordDto

data class ForgotPasswordDto(val enteredUsername: String)

Forgot Password request body DTO.

ForgotPasswordPinDto

data class ForgotPasswordPinDto(val pin: String)

Forgot Password Pin enter request body DTO.

ForgotPasswordResult

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

GeneralCommand

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

GeneralCommandMessage

data class GeneralCommandMessage(val data: GeneralCommand? = null, val messageId: UUID) : OutboundWebSocketMessage

General command websocket message.

GeneralCommandType

enum GeneralCommandType : Enum<GeneralCommandType>

This exists simply to identify a set of known commands.

GetProgramsDto

data class GetProgramsDto(val channelIds: List<UUID>, val userId: UUID? = null, 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<ItemSortBy>, 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

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

Class GroupInfoDto.

GroupInfoDtoGroupUpdate

data class GroupInfoDtoGroupUpdate(val groupId: UUID, val type: GroupUpdateType, val data: GroupInfoDto)

Class GroupUpdate.

GroupQueueMode

enum GroupQueueMode : Enum<GroupQueueMode>

Enum GroupQueueMode.

GroupRepeatMode

enum GroupRepeatMode : Enum<GroupRepeatMode>

Enum GroupRepeatMode.

GroupShuffleMode

enum GroupShuffleMode : Enum<GroupShuffleMode>

Enum GroupShuffleMode.

GroupStateType

enum GroupStateType : Enum<GroupStateType>

Enum GroupState.

GroupStateUpdate

data class GroupStateUpdate(val state: GroupStateType, val reason: PlaybackRequestType)

Class GroupStateUpdate.

GroupStateUpdateGroupUpdate

data class GroupStateUpdateGroupUpdate(val groupId: UUID, val type: GroupUpdateType, val data: GroupStateUpdate)

Class GroupUpdate.

GroupUpdate

data class GroupUpdate(val groupId: UUID, val type: GroupUpdateType)

Group update without data.

GroupUpdateType

enum GroupUpdateType : Enum<GroupUpdateType>

Enum GroupUpdateType.

GuideInfo

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

HardwareEncodingType

enum HardwareEncodingType : Enum<HardwareEncodingType>

Enum HardwareEncodingType.

IgnoreWaitRequestDto

data class IgnoreWaitRequestDto(val ignoreWait: Boolean)

Class IgnoreWaitRequestDto.

ImageFormat

enum ImageFormat : Enum<ImageFormat>

Enum ImageOutputFormat.

ImageInfo

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

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

ImageOrientation

enum ImageOrientation : Enum<ImageOrientation>

ImageProviderInfo

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

Class ImageProviderInfo.

ImageResolution

enum ImageResolution : Enum<ImageResolution>

Enum ImageResolution.

ImageSavingConvention

enum ImageSavingConvention : Enum<ImageSavingConvention>

ImageType

enum ImageType : Enum<ImageType>

Enum ImageType.

InboundKeepAliveMessage

class InboundKeepAliveMessage : InboundWebSocketMessage

Keep alive websocket messages.

InboundWebSocketMessage

sealed interface InboundWebSocketMessage : WebSocketMessage

Represents the list of possible inbound websocket types

InstallationInfo

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

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

enum IsoType : Enum<IsoType>

Enum IsoType.

ItemCounts

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

enum ItemFields : Enum<ItemFields>

Used to control the data that gets attached to DtoBaseItems.

ItemFilter

enum ItemFilter : Enum<ItemFilter>

Enum ItemFilter.

ItemSortBy

enum ItemSortBy : Enum<ItemSortBy>

These represent sort orders.

JoinGroupRequestDto

data class JoinGroupRequestDto(val groupId: UUID)

Class JoinGroupRequestDto.

KeepUntil

enum KeepUntil : Enum<KeepUntil>

LibraryChangedMessage

data class LibraryChangedMessage(val data: LibraryUpdateInfo? = null, val messageId: UUID) : OutboundWebSocketMessage

Library changed message.

LibraryOptionInfoDto

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

Library option info dto.

LibraryOptions

data class LibraryOptions(val enabled: Boolean, val enablePhotos: Boolean, val enableRealtimeMonitor: Boolean, val enableLufsScan: Boolean, val enableChapterImageExtraction: Boolean, val extractChapterImagesDuringLibraryScan: Boolean, val enableTrickplayImageExtraction: Boolean, val extractTrickplayImagesDuringLibraryScan: Boolean, val pathInfos: List<MediaPathInfo>, val saveLocalMetadata: Boolean, val enableInternetProviders: Boolean, val enableAutomaticSeriesGrouping: Boolean, val enableEmbeddedTitles: Boolean, val enableEmbeddedExtrasTitles: 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 saveLyricsWithMedia: Boolean = false, val automaticallyAddToCollection: Boolean, val allowEmbeddedSubtitles: EmbeddedSubtitleOptions, val typeOptions: List<TypeOptions>)

LibraryOptionsResultDto

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

Library options result dto.

LibraryTypeOptionsDto

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

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

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

data class LiveStreamResponse(val mediaSource: MediaSourceInfo)

LiveTvInfo

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

LiveTvOptions

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, val saveRecordingNfo: Boolean, val saveRecordingImages: Boolean)

LiveTvServiceInfo

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

enum LiveTvServiceStatus : Enum<LiveTvServiceStatus>

LocalizationOption

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

LocationType

enum LocationType : Enum<LocationType>

Enum LocationType.

LogFile

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

LogLevel

enum LogLevel : Enum<LogLevel>

LyricDto

data class LyricDto(val metadata: LyricMetadata, val lyrics: List<LyricLine>)

LyricResponse model.

LyricLine

data class LyricLine(val text: String, val start: Long? = null)

Lyric model.

LyricMetadata

data class LyricMetadata(val artist: String? = null, val album: String? = null, val title: String? = null, val author: String? = null, val length: Long? = null, val by: String? = null, val offset: Long? = null, val creator: String? = null, val version: String? = null, val isSynced: Boolean? = null)

LyricMetadata model.

MediaAttachment

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.

MediaPathDto

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

Media Path dto.

MediaPathInfo

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

MediaProtocol

enum MediaProtocol : Enum<MediaProtocol>

MediaSourceInfo

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: MediaStreamProtocol, val transcodingContainer: String? = null, val analyzeDurationMs: Int? = null, val defaultAudioStreamIndex: Int? = null, val defaultSubtitleStreamIndex: Int? = null)

MediaSourceType

enum MediaSourceType : Enum<MediaSourceType>

MediaStream

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: VideoRange, val videoRangeType: VideoRangeType, val videoDoViTitle: String? = null, val localizedUndefined: String? = null, val localizedDefault: String? = null, val localizedForced: String? = null, val localizedExternal: String? = null, val localizedHearingImpaired: 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 isHearingImpaired: 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.

MediaStreamProtocol

enum MediaStreamProtocol : Enum<MediaStreamProtocol>

Media streaming protocol. Lowercase for backwards compatibility.

MediaStreamType

enum MediaStreamType : Enum<MediaStreamType>

Enum MediaStreamType.

MediaType

enum MediaType : Enum<MediaType>

Media types.

MediaUpdateInfoDto

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

Media Update Info Dto.

MediaUpdateInfoPathDto

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

The media update info path.

MediaUrl

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

MessageCommand

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

MetadataConfiguration

data class MetadataConfiguration(val useFileCreationTimeForDateAdded: Boolean)

MetadataEditorInfo

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

MetadataField

enum MetadataField : Enum<MetadataField>

Enum MetadataFields.

MetadataOptions

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

enum MetadataRefreshMode : Enum<MetadataRefreshMode>

MovePlaylistItemRequestDto

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

Class MovePlaylistItemRequestDto.

MovieInfo

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

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

MusicVideoInfo

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

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

NameGuidPair

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

NameIdPair

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

NameValuePair

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

NetworkConfiguration

data class NetworkConfiguration(val baseUrl: String, val enableHttps: Boolean, val requireHttps: Boolean, val certificatePath: String, val certificatePassword: String, val internalHttpPort: Int, val internalHttpsPort: Int, val publicHttpPort: Int, val publicHttpsPort: Int, val autoDiscovery: Boolean, val enableUPnP: Boolean, val enableIPv4: Boolean, val enableIPv6: Boolean, val enableRemoteAccess: Boolean, val localNetworkSubnets: List<String>, val localNetworkAddresses: List<String>, val knownProxies: List<String>, val ignoreVirtualInterfaces: Boolean, val virtualInterfaceNames: List<String>, val enablePublishedServerUriByRequest: Boolean, val publishedServerUriBySubnet: List<String>, val remoteIpFilter: List<String>, val isRemoteIpFilterBlacklist: Boolean)

Defines the MediaBrowser.Common.Net.NetworkConfiguration.

NewGroupRequestDto

data class NewGroupRequestDto(val groupName: String)

Class NewGroupRequestDto.

NextItemRequestDto

data class NextItemRequestDto(val playlistItemId: UUID)

Class NextItemRequestDto.

OpenLiveStreamDto

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.

OutboundKeepAliveMessage

data class OutboundKeepAliveMessage(val messageId: UUID) : OutboundWebSocketMessage

Keep alive websocket messages.

OutboundWebSocketMessage

sealed interface OutboundWebSocketMessage : WebSocketMessage

Represents the list of possible outbound websocket types

PackageInfo

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

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

Class ParentalRating.

PathSubstitution

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

Defines the MediaBrowser.Model.Configuration.PathSubstitution.

PersonKind

enum PersonKind : Enum<PersonKind>

The person kind.

PersonLookupInfo

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

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

PingRequestDto

data class PingRequestDto(val ping: Long)

Class PingRequestDto.

PinRedeemResult

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

PlayAccess

enum PlayAccess : Enum<PlayAccess>

PlaybackErrorCode

enum PlaybackErrorCode : Enum<PlaybackErrorCode>

PlaybackInfoDto

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

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

Class PlaybackInfoResponse.

PlaybackOrder

enum PlaybackOrder : Enum<PlaybackOrder>

Enum PlaybackOrder.

PlaybackProgressInfo

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 playbackOrder: PlaybackOrder, val nowPlayingQueue: List<QueueItem>? = null, val playlistItemId: String? = null)

Class PlaybackProgressInfo.

PlaybackRequestType

enum PlaybackRequestType : Enum<PlaybackRequestType>

Enum PlaybackRequestType.

PlaybackStartInfo

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 playbackOrder: PlaybackOrder, val nowPlayingQueue: List<QueueItem>? = null, val playlistItemId: String? = null)

Class PlaybackStartInfo.

PlaybackStopInfo

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

enum PlayCommand : Enum<PlayCommand>

Enum PlayCommand.

PlayerStateInfo

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 playbackOrder: PlaybackOrder, val liveStreamId: String? = null)

PlaylistCreationResult

data class PlaylistCreationResult(val id: String)

PlaylistUserPermissions

data class PlaylistUserPermissions(val userId: UUID, val canEdit: Boolean)

Class to hold data on user permissions for playlists.

PlayMessage

data class PlayMessage(val data: PlayRequest? = null, val messageId: UUID) : OutboundWebSocketMessage

Play command websocket message.

PlayMethod

enum PlayMethod : Enum<PlayMethod>

PlayQueueUpdate

data class PlayQueueUpdate(val reason: PlayQueueUpdateReason, val lastUpdate: DateTime, val playlist: List<SyncPlayQueueItem>, val playingItemIndex: Int, val startPositionTicks: Long, val isPlaying: Boolean, val shuffleMode: GroupShuffleMode, val repeatMode: GroupRepeatMode)

Class PlayQueueUpdate.

PlayQueueUpdateGroupUpdate

data class PlayQueueUpdateGroupUpdate(val groupId: UUID, val type: GroupUpdateType, val data: PlayQueueUpdate)

Class GroupUpdate.

PlayQueueUpdateReason

enum PlayQueueUpdateReason : Enum<PlayQueueUpdateReason>

Enum PlayQueueUpdateReason.

PlayRequest

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

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

Class PlayRequestDto.

PlaystateCommand

enum PlaystateCommand : Enum<PlaystateCommand>

Enum PlaystateCommand.

PlaystateMessage

data class PlaystateMessage(val data: PlaystateRequest? = null, val messageId: UUID) : OutboundWebSocketMessage

Playstate message.

PlaystateRequest

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

PluginInfo

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.

PluginInstallationCancelledMessage

data class PluginInstallationCancelledMessage(val data: InstallationInfo? = null, val messageId: UUID) : OutboundWebSocketMessage

Plugin installation cancelled message.

PluginInstallationCompletedMessage

data class PluginInstallationCompletedMessage(val data: InstallationInfo? = null, val messageId: UUID) : OutboundWebSocketMessage

Plugin installation completed message.

PluginInstallationFailedMessage

data class PluginInstallationFailedMessage(val data: InstallationInfo? = null, val messageId: UUID) : OutboundWebSocketMessage

Plugin installation failed message.

PluginInstallingMessage

data class PluginInstallingMessage(val data: InstallationInfo? = null, val messageId: UUID) : OutboundWebSocketMessage

Package installing message.

PluginStatus

enum PluginStatus : Enum<PluginStatus>

Plugin load status.

PluginUninstalledMessage

data class PluginUninstalledMessage(val data: PluginInfo? = null, val messageId: UUID) : OutboundWebSocketMessage

Plugin uninstalled message.

PreviousItemRequestDto

data class PreviousItemRequestDto(val playlistItemId: UUID)

Class PreviousItemRequestDto.

ProblemDetails

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

ProcessPriorityClass

enum ProcessPriorityClass : Enum<ProcessPriorityClass>

ProfileCondition

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

ProfileConditionType

enum ProfileConditionType : Enum<ProfileConditionType>

ProfileConditionValue

enum ProfileConditionValue : Enum<ProfileConditionValue>

ProgramAudio

enum ProgramAudio : Enum<ProgramAudio>

PublicSystemInfo

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

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

QueryFiltersLegacy

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

QueueItem

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

QueueRequestDto

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

Class QueueRequestDto.

QuickConnectDto

data class QuickConnectDto(val secret: String)

The quick connect request body.

QuickConnectResult

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

enum RatingType : Enum<RatingType>

ReadyRequestDto

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

Class ReadyRequest.

RecommendationDto

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

RecommendationType

enum RecommendationType : Enum<RecommendationType>

RecordingStatus

enum RecordingStatus : Enum<RecordingStatus>

RefreshProgressMessage

data class RefreshProgressMessage(val data: Map<String, String?>? = null, val messageId: UUID) : OutboundWebSocketMessage

Refresh progress message.

RemoteImageInfo

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

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

Class RemoteImageResult.

RemoteLyricInfoDto

data class RemoteLyricInfoDto(val id: String, val providerName: String, val lyrics: LyricDto)

The remote lyric info dto.

RemoteSearchResult

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

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 frameRate: Float? = null, val downloadCount: Int? = null, val isHashMatch: Boolean? = null, val aiTranslated: Boolean? = null, val machineTranslated: Boolean? = null, val forced: Boolean? = null, val hearingImpaired: Boolean? = null)

RemoveFromPlaylistRequestDto

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

Class RemoveFromPlaylistRequestDto.

RepeatMode

enum RepeatMode : Enum<RepeatMode>

RepositoryInfo

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

Class RepositoryInfo.

RestartRequiredMessage

data class RestartRequiredMessage(val messageId: UUID) : OutboundWebSocketMessage

Restart required.

ScheduledTaskEndedMessage

data class ScheduledTaskEndedMessage(val data: TaskResult? = null, val messageId: UUID) : OutboundWebSocketMessage

Scheduled task ended message.

ScheduledTasksInfoMessage

data class ScheduledTasksInfoMessage(val data: List<TaskInfo>? = null, val messageId: UUID) : OutboundWebSocketMessage

Scheduled tasks info message.

ScheduledTasksInfoStartMessage

data class ScheduledTasksInfoStartMessage(val data: String? = null) : InboundWebSocketMessage

Scheduled tasks info start message. Data is the timing data encoded as "$initialDelay,$interval" in ms.

ScheduledTasksInfoStopMessage

class ScheduledTasksInfoStopMessage : InboundWebSocketMessage

Scheduled tasks info stop message.

ScrollDirection

enum ScrollDirection : Enum<ScrollDirection>

An enum representing the axis that should be scrolled.

SearchHint

data class SearchHint(val itemId: UUID, val id: UUID, val name: String, 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: BaseItemKind, val isFolder: Boolean? = null, val runTimeTicks: Long? = null, val mediaType: MediaType, val startDate: DateTime? = null, val endDate: DateTime? = null, val series: String? = null, val status: String? = null, val album: String? = null, val albumId: UUID? = null, val albumArtist: String? = null, val artists: List<String>, val songCount: Int? = null, val episodeCount: Int? = null, val channelId: UUID? = null, val channelName: String? = null, val primaryImageAspectRatio: Double? = null)

Class SearchHintResult.

SearchHintResult

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

Class SearchHintResult.

SeekRequestDto

data class SeekRequestDto(val positionTicks: Long)

Class SeekRequestDto.

SendCommand

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

enum SendCommandType : Enum<SendCommandType>

Enum SendCommandType.

SeriesInfo

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

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

SeriesStatus

enum SeriesStatus : Enum<SeriesStatus>

The status of a series.

SeriesTimerCancelledMessage

data class SeriesTimerCancelledMessage(val data: TimerEventInfo? = null, val messageId: UUID) : OutboundWebSocketMessage

Series timer cancelled message.

SeriesTimerCreatedMessage

data class SeriesTimerCreatedMessage(val data: TimerEventInfo? = null, val messageId: UUID) : OutboundWebSocketMessage

Series timer created message.

SeriesTimerInfoDto

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

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

ServerConfiguration

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 inactiveSessionThreshold: Int, val libraryMonitorDelay: Int, val libraryUpdateDuration: 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, val dummyChapterDuration: Int, val chapterImageResolution: ImageResolution, val parallelImageEncodingLimit: Int, val castReceiverApplications: List<CastReceiverApplication>, val trickplayOptions: TrickplayOptions)

Represents the server configuration.

ServerDiscoveryInfo

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

The server discovery info model.

ServerRestartingMessage

data class ServerRestartingMessage(val messageId: UUID) : OutboundWebSocketMessage

Server restarting down message.

ServerShuttingDownMessage

data class ServerShuttingDownMessage(val messageId: UUID) : OutboundWebSocketMessage

Server shutting down message.

SessionInfo

data class SessionInfo(val playState: PlayerStateInfo? = null, val additionalUsers: List<SessionUserInfo>? = null, val capabilities: ClientCapabilities? = null, val remoteEndPoint: String? = null, val playableMediaTypes: List<MediaType>? = null, val id: String? = null, val userId: UUID, val userName: String? = null, val client: String? = null, val lastActivityDate: DateTime, val lastPlaybackCheckIn: DateTime, val lastPausedDate: DateTime? = null, val deviceName: String? = null, val deviceType: String? = null, val nowPlayingItem: BaseItemDto? = 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

enum SessionMessageType : Enum<SessionMessageType>

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

SessionsMessage

data class SessionsMessage(val data: List<SessionInfo>? = null, val messageId: UUID) : OutboundWebSocketMessage

Sessions message.

SessionsStartMessage

data class SessionsStartMessage(val data: String? = null) : InboundWebSocketMessage

Sessions start message. Data is the timing data encoded as "$initialDelay,$interval" in ms.

SessionsStopMessage

class SessionsStopMessage : InboundWebSocketMessage

Sessions stop message.

SessionUserInfo

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

Class SessionUserInfo.

SetChannelMappingDto

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

Set channel mapping dto.

SetPlaylistItemRequestDto

data class SetPlaylistItemRequestDto(val playlistItemId: UUID)

Class SetPlaylistItemRequestDto.

SetRepeatModeRequestDto

data class SetRepeatModeRequestDto(val mode: GroupRepeatMode)

Class SetRepeatModeRequestDto.

SetShuffleModeRequestDto

data class SetShuffleModeRequestDto(val mode: GroupShuffleMode)

Class SetShuffleModeRequestDto.

SongInfo

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

enum SortOrder : Enum<SortOrder>

An enum representing the sorting order.

SpecialViewOptionDto

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

Special view option dto.

StartupConfigurationDto

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

The startup configuration DTO.

StartupRemoteAccessDto

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

Startup remote access dto.

StartupUserDto

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

The startup user DTO.

StringGroupUpdate

data class StringGroupUpdate(val groupId: UUID, val type: GroupUpdateType, val data: String)

Class GroupUpdate.

SubtitleDeliveryMethod

enum SubtitleDeliveryMethod : Enum<SubtitleDeliveryMethod>

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

SubtitleOptions

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

enum SubtitlePlaybackMode : Enum<SubtitlePlaybackMode>

An enum representing a subtitle playback mode.

SubtitleProfile

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

SyncPlayCommandMessage

data class SyncPlayCommandMessage(val data: SendCommand? = null, val messageId: UUID) : OutboundWebSocketMessage

Sync play command.

SyncPlayGroupUpdateCommandMessage

data class SyncPlayGroupUpdateCommandMessage(val data: GroupUpdate? = null, val messageId: UUID) : OutboundWebSocketMessage

Untyped sync play command.

SyncPlayQueueItem

data class SyncPlayQueueItem(val itemId: UUID, val playlistItemId: UUID)

Class QueueItem.

SyncPlayUserAccessType

enum SyncPlayUserAccessType : Enum<SyncPlayUserAccessType>

Enum SyncPlayUserAccessType.

SystemInfo

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 = true, val canLaunchWebBrowser: Boolean = false, 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 castReceiverApplications: List<CastReceiverApplication>? = null, val hasUpdateAvailable: Boolean = false, val encoderLocation: String? = "System", val systemArchitecture: String? = "X64")

Class SystemInfo.

TaskCompletionStatus

enum TaskCompletionStatus : Enum<TaskCompletionStatus>

Enum TaskCompletionStatus.

TaskInfo

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

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

enum TaskState : Enum<TaskState>

Enum TaskState.

TaskTriggerInfo

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

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

Class ThemeMediaResult.

TimerCancelledMessage

data class TimerCancelledMessage(val data: TimerEventInfo? = null, val messageId: UUID) : OutboundWebSocketMessage

Timer cancelled message.

TimerCreatedMessage

data class TimerCreatedMessage(val data: TimerEventInfo? = null, val messageId: UUID) : OutboundWebSocketMessage

Timer created message.

TimerEventInfo

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

TimerInfoDto

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

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

TrailerInfo

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

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

TranscodeReason

enum TranscodeReason : Enum<TranscodeReason>

TranscodeSeekInfo

enum TranscodeSeekInfo : Enum<TranscodeSeekInfo>

TranscodingInfo

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

data class TranscodingProfile(val container: String, val type: DlnaProfileType, val videoCodec: String, val audioCodec: String, val protocol: MediaStreamProtocol, 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

enum TransportStreamTimestamp : Enum<TransportStreamTimestamp>

TrickplayInfo

data class TrickplayInfo(val width: Int, val height: Int, val tileWidth: Int, val tileHeight: Int, val thumbnailCount: Int, val interval: Int, val bandwidth: Int)

An entity representing the metadata for a group of trickplay tiles.

TrickplayOptions

data class TrickplayOptions(val enableHwAcceleration: Boolean, val enableHwEncoding: Boolean, val scanBehavior: TrickplayScanBehavior, val processPriority: ProcessPriorityClass, val interval: Int, val widthResolutions: List<Int>, val tileWidth: Int, val tileHeight: Int, val qscale: Int, val jpegQuality: Int, val processThreads: Int)

Class TrickplayOptions.

TrickplayScanBehavior

enum TrickplayScanBehavior : Enum<TrickplayScanBehavior>

Enum TrickplayScanBehavior.

TunerChannelMapping

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

TunerHostInfo

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, val ignoreDts: Boolean)

TypeOptions

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

enum UnratedItem : Enum<UnratedItem>

An enum representing an unrated item.

UpdateLibraryOptionsDto

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

Update library options dto.

UpdateMediaPathRequestDto

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

Update library options dto.

UpdatePlaylistDto

data class UpdatePlaylistDto(val name: String? = null, val ids: List<UUID>? = null, val users: List<PlaylistUserPermissions>? = null, val isPublic: Boolean? = null)

Update existing playlist dto. Fields set to null will not be updated and keep their current values.

UpdatePlaylistUserDto

data class UpdatePlaylistUserDto(val canEdit: Boolean? = null)

Update existing playlist user dto. Fields set to null will not be updated and keep their current values.

UpdateUserItemDataDto

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

This is used by the api to get information about a item user data.

UpdateUserPassword

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

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

Upload subtitles dto.

UserConfiguration

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

Class UserConfiguration.

UserDataChangedMessage

data class UserDataChangedMessage(val data: UserDataChangeInfo? = null, val messageId: UUID) : OutboundWebSocketMessage

User data changed message.

UserDataChangeInfo

data class UserDataChangeInfo(val userId: String? = null, val userDataList: List<UserItemDataDto>? = null)

Class UserDataChangeInfo.

UserDeletedMessage

data class UserDeletedMessage(val data: UUID, val messageId: UUID) : OutboundWebSocketMessage

User deleted message.

UserDto

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

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

data class UserPolicy(val isAdministrator: Boolean, val isHidden: Boolean, val enableCollectionManagement: Boolean = false, val enableSubtitleManagement: Boolean = false, val enableLyricManagement: Boolean = false, val isDisabled: Boolean, val maxParentalRating: Int? = null, val blockedTags: List<String>? = null, val allowedTags: 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, val passwordResetProviderId: String, val syncPlayAccess: SyncPlayUserAccessType)

UserUpdatedMessage

data class UserUpdatedMessage(val data: UserDto? = null, val messageId: UUID) : OutboundWebSocketMessage

User updated message.

UtcTimeResponse

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

Class UtcTimeResponse.

ValidatePathDto

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

Validate path object.

VersionInfo

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

enum Video3dFormat : Enum<Video3dFormat>

VideoRange

enum VideoRange : Enum<VideoRange>

An enum representing video ranges.

VideoRangeType

enum VideoRangeType : Enum<VideoRangeType>

An enum representing types of video ranges.

VideoType

enum VideoType : Enum<VideoType>

Enum VideoType.

VirtualFolderInfo

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

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

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

WebSocketMessage

sealed interface WebSocketMessage

Represents the possible websocket types

XbmcMetadataOptions

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