Package-level declarations

Types

Link copied to clipboard
@Serializable
abstract class Film : Serializable

An abstract representation of a film.

Link copied to clipboard
@Serializable
abstract class FilmDetails : FilmMetadata

An abstract representation of detailed film information. Deprecated in favor of FilmMetadata.

Link copied to clipboard
@Serializable
abstract class FilmMetadata : Film

An abstract representation of detailed film information.

Link copied to clipboard

Represents the release status of a film.

Link copied to clipboard
@Serializable
data class FilmSearchItem(val id: String?, val providerId: String, val filmType: FilmType, val homePage: String?, val title: String, val posterImage: String?, val adult: Boolean = false, val backdropImage: String? = null, val imdbId: String? = null, val tmdbId: Int? = null, val releaseDate: String? = null, val rating: Double? = null, val language: String? = null, val overview: String? = null, val year: Int? = null, val logoImage: String? = null, val genres: List<Genre> = emptyList(), val customProperties: Map<String, String?> = emptyMap(), val voteCount: Int = 0, val genreIds: List<Int> = emptyList()) : Film

Represents a film search result item.

Link copied to clipboard
@Serializable
data class Genre(val id: Int, val name: String, val mediaType: String? = null) : Serializable

Data class representing a genre (e.g., for movies or TV shows).

Link copied to clipboard
@Serializable
data class Movie(val id: String?, val title: String, val posterImage: String?, val homePage: String?, val backdropImage: String? = null, val logoImage: String? = null, val tmdbId: Int? = null, val imdbId: String? = null, val language: String? = null, val releaseDate: String? = null, val rating: Double? = null, val producers: List<Company> = emptyList(), val recommendations: List<FilmSearchItem> = emptyList(), val providerId: String, val adult: Boolean = false, val runtime: Int? = null, val overview: String? = null, val tagLine: String? = null, val year: Int? = null, val genres: List<Genre> = emptyList(), val cast: List<Person> = emptyList(), val customProperties: Map<String, String?> = emptyMap(), val collection: TMDBCollection? = null) : FilmMetadata

Represents a detailed information of a movie.

Link copied to clipboard
@Serializable
data class Person(val id: Int, val name: String, val imdbId: String? = null, val biography: String? = null, val homepage: String? = null, val character: String? = null, val knownFor: String? = null, val birthDay: String? = null, val deathDay: String? = null, val rawGender: Int? = null, val profilePath: String? = null) : Serializable

Represents a person with details such as name, biography, and professional information.

Link copied to clipboard
@Serializable
data class SearchResponseData<T>(val page: Int = 1, val results: List<T> = emptyList(), val hasNextPage: Boolean = false, val totalPages: Int = 0)

Represents the data returned from a search request.

Link copied to clipboard
@Serializable
data class TMDBCollection(val id: Int, val overview: String? = null, val films: List<FilmSearchItem>, val backdropPath: String?, val collectionName: String, val posterPath: String?) : Serializable

Represents a collection of films as retrieved from TMDB.

Link copied to clipboard
@Serializable
data class TvShow(val id: String?, val title: String, val posterImage: String?, val homePage: String?, val backdropImage: String? = null, val logoImage: String? = null, val tmdbId: Int? = null, val imdbId: String? = null, val language: String? = null, val releaseDate: String? = null, val parsedReleaseDate: String? = null, val rating: Double? = null, val producers: List<Company> = emptyList(), val recommendations: List<FilmSearchItem> = emptyList(), val providerId: String, val adult: Boolean = false, val overview: String? = null, val tagLine: String? = null, val year: Int? = null, val genres: List<Genre> = emptyList(), val cast: List<Person> = emptyList(), val customProperties: Map<String, String?> = emptyMap(), val networks: List<Company> = emptyList(), val seasons: List<Season> = emptyList(), val totalEpisodes: Int = 0, val totalSeasons: Int = 0, val runtime: Int? = null) : FilmMetadata

Represents a detailed information of a TV show.

Properties

Link copied to clipboard

The default film source name. Defaults to TMDB.