Library/com.lagradost.cloudstream3

Package-level declarations

Types

data class Actor(val name: String, val image: String? = null)

Data class hold Actor personal information

data class ActorData(val actor: Actor, val role: ActorRole? = null, val roleString: String? = null, val voiceActor: Actor? = null)

Data class hold Actor information

ActorRole

enum ActorRole : Enum<ActorRole>

enum class of Actor roles (Main, Supporting, Background).

AnimeLoadResponse

data class AnimeLoadResponse( var engName: String? = null, var japName: String? = null, var name: String, var url: String, var apiName: String, var type: TvType, var posterUrl: String? = null, var year: Int? = null, var episodes: MutableMap<DubStatus, List<Episode>> = mutableMapOf(), var showStatus: ShowStatus? = null, var plot: String? = null, var tags: List<String>? = null, var synonyms: List<String>? = null, var rating: Int? = null, var duration: Int? = null, var trailers: MutableList<TrailerData> = mutableListOf(), var recommendations: List<SearchResponse>? = null, var actors: List<ActorData>? = null, var comingSoon: Boolean = false, var syncData: MutableMap<String, String> = mutableMapOf(), var posterHeaders: Map<String, String>? = null, var nextAiring: NextAiring? = null, var seasonNames: List<SeasonData>? = null, var backgroundPosterUrl: String? = null, var contentRating: String? = null) : LoadResponse, EpisodeResponse

Data class of LoadResponse interface for Anime.

AnimeSearchResponse

data class AnimeSearchResponse( val name: String, val url: String, val apiName: String, var type: TvType? = null, var posterUrl: String? = null, var year: Int? = null, var dubStatus: EnumSet<DubStatus>? = null, var otherName: String? = null, var episodes: MutableMap<DubStatus, Int> = mutableMapOf(), var id: Int? = null, var quality: SearchQuality? = null, var posterHeaders: Map<String, String>? = null) : SearchResponse

Data class of SearchResponse interface for Anime.

AniSearch

data class AniSearch(var data: AniSearch.Data? = Data())

APIHolder

object APIHolder

AutoDownloadMode

enum AutoDownloadMode : Enum<AutoDownloadMode>

DubStatus

enum DubStatus : Enum<DubStatus>

Episode

data class Episode( var data: String, var name: String? = null, var season: Int? = null, var episode: Int? = null, var posterUrl: String? = null, var rating: Int? = null, var description: String? = null, var date: Long? = null, var runTime: Int? = null)

Episode information that will be passed to LoadLinks function & showed on UI

EpisodeResponse

interface EpisodeResponse

Abstract interface of EpisodeResponse

ErrorLoadingException

class ErrorLoadingException(message: String? = null) : Exception

HomePageList

data class HomePageList(val name: String, var list: List<SearchResponse>, val isHorizontalImages: Boolean = false)

Data class for the Homepage list info.

HomePageResponse

data class HomePageResponse(val items: List<HomePageList>, val hasNext: Boolean = false)

Data class for the Homepage response info.

IDownloadableMinimum

interface IDownloadableMinimum

LiveSearchResponse

data class LiveSearchResponse( val name: String, val url: String, val apiName: String, var type: TvType? = null, var posterUrl: String? = null, var id: Int? = null, var quality: SearchQuality? = null, var posterHeaders: Map<String, String>? = null, var lang: String? = null) : SearchResponse

Data class of SearchResponse interface for Live streams.

LiveStreamLoadResponse

data class LiveStreamLoadResponse( var name: String, var url: String, var apiName: String, var dataUrl: String, var posterUrl: String? = null, var year: Int? = null, var plot: String? = null, var type: TvType = TvType.Live, var rating: Int? = null, var tags: List<String>? = null, var duration: Int? = null, var trailers: MutableList<TrailerData> = mutableListOf(), var recommendations: List<SearchResponse>? = null, var actors: List<ActorData>? = null, var comingSoon: Boolean = false, var syncData: MutableMap<String, String> = mutableMapOf(), var posterHeaders: Map<String, String>? = null, var backgroundPosterUrl: String? = null, var contentRating: String? = null) : LoadResponse

Data class of LoadResponse interface for Live streams.

LoadResponse

interface LoadResponse

Abstract interface of LoadResponse responses

MainAPI

abstract class MainAPI

Every provider will not have try catch built in, so handle exceptions when calling these functions

MainPageData

data class MainPageData(val name: String, val data: String, val horizontalImages: Boolean = false)

MainPageRequest

data class MainPageRequest(val name: String, val data: String, val horizontalImages: Boolean)

MovieLoadResponse

data class MovieLoadResponse( var name: String, var url: String, var apiName: String, var type: TvType, var dataUrl: String, var posterUrl: String? = null, var year: Int? = null, var plot: String? = null, var rating: Int? = null, var tags: List<String>? = null, var duration: Int? = null, var trailers: MutableList<TrailerData> = mutableListOf(), var recommendations: List<SearchResponse>? = null, var actors: List<ActorData>? = null, var comingSoon: Boolean = false, var syncData: MutableMap<String, String> = mutableMapOf(), var posterHeaders: Map<String, String>? = null, var backgroundPosterUrl: String? = null, var contentRating: String? = null) : LoadResponse

Data class of LoadResponse interface for Movies.

MovieSearchResponse

data class MovieSearchResponse( val name: String, val url: String, val apiName: String, var type: TvType? = null, var posterUrl: String? = null, var year: Int? = null, var id: Int? = null, var quality: SearchQuality? = null, var posterHeaders: Map<String, String>? = null) : SearchResponse

Data class of SearchResponse interface for Movies.

NextAiring

data class NextAiring(val episode: Int, val unixTime: Long, val season: Int? = null)

Data class holds next airing Episode info.

Prerelease

annotation class Prerelease

Api has not yet been published to stable, and will cause NoSuchMethodException on stable

ProvidersInfoJson

data class ProvidersInfoJson(var name: String, var url: String, var credentials: String? = null, var status: Int)

ProviderType

enum ProviderType : Enum<ProviderType>

enum class determines provider type:

SearchQuality

enum SearchQuality : Enum<SearchQuality>

enum class holds search quality.

SearchResponse

interface SearchResponse

Abstract interface of SearchResponse.

SeasonData

data class SeasonData(val season: Int, val name: String? = null, val displaySeason: Int? = null)

Data class holds season info.

SettingsJson

data class SettingsJson(var enableAdult: Boolean = false)

ShowStatus

enum ShowStatus : Enum<ShowStatus>

enum class determines Show status (Completed or Ongoing)

SimklSyncServices

enum SimklSyncServices : Enum<SimklSyncServices>

Set of sync services simkl is compatible with. Add more as required: https://simkl.docs.apiary.io/#reference/search/id-lookup/get-items-by-id

SubtitleFile

data class SubtitleFile(val lang: String, val url: String)

Data class for the Subtitle file info.

TorrentLoadResponse

data class TorrentLoadResponse( var name: String, var url: String, var apiName: String, var magnet: String?, var torrent: String?, var plot: String?, var type: TvType = TvType.Torrent, var posterUrl: String? = null, var year: Int? = null, var rating: Int? = null, var tags: List<String>? = null, var duration: Int? = null, var trailers: MutableList<TrailerData> = mutableListOf(), var recommendations: List<SearchResponse>? = null, var actors: List<ActorData>? = null, var comingSoon: Boolean = false, var syncData: MutableMap<String, String> = mutableMapOf(), var posterHeaders: Map<String, String>? = null, var backgroundPosterUrl: String? = null, var contentRating: String? = null) : LoadResponse

Data class of LoadResponse interface for Torrent.

TorrentSearchResponse

data class TorrentSearchResponse( val name: String, val url: String, val apiName: String, var type: TvType?, var posterUrl: String?, var id: Int? = null, var quality: SearchQuality? = null, var posterHeaders: Map<String, String>? = null) : SearchResponse

Data class of SearchResponse interface for Torrent.

Tracker

data class Tracker(val malId: Int? = null, val aniId: String? = null, val image: String? = null, val cover: String? = null)

TrackerType

enum TrackerType : Enum<TrackerType>

used for the getTracker() method

TrailerData

data class TrailerData(val extractorUrl: String, val referer: String?, val raw: Boolean, val headers: Map<String, String> = mapOf())

Data class of Trailer data.

TvSeriesLoadResponse

data class TvSeriesLoadResponse( var name: String, var url: String, var apiName: String, var type: TvType, var episodes: List<Episode>, var posterUrl: String? = null, var year: Int? = null, var plot: String? = null, var showStatus: ShowStatus? = null, var rating: Int? = null, var tags: List<String>? = null, var duration: Int? = null, var trailers: MutableList<TrailerData> = mutableListOf(), var recommendations: List<SearchResponse>? = null, var actors: List<ActorData>? = null, var comingSoon: Boolean = false, var syncData: MutableMap<String, String> = mutableMapOf(), var posterHeaders: Map<String, String>? = null, var nextAiring: NextAiring? = null, var seasonNames: List<SeasonData>? = null, var backgroundPosterUrl: String? = null, var contentRating: String? = null) : LoadResponse, EpisodeResponse

Data class of LoadResponse interface for Tv series.

TvSeriesSearchResponse

data class TvSeriesSearchResponse( val name: String, val url: String, val apiName: String, var type: TvType? = null, var posterUrl: String? = null, var year: Int? = null, var episodes: Int? = null, var id: Int? = null, var quality: SearchQuality? = null, var posterHeaders: Map<String, String>? = null) : SearchResponse

Data class of SearchResponse interface for Tv series.

TvType

enum TvType : Enum<TvType>

VPNStatus

enum VPNStatus : Enum<VPNStatus>

enum class determines VPN status (Non, MightBeNeeded or Torrent)

Properties

AllLanguagesName

const val AllLanguagesName: String

Defines the constant for the all languages preference, if this is set then it is the equivalent of all languages being set

app

var app: Requests

mapper

val mapper: JsonMapper

PROVIDER_STATUS_BETA_ONLY

const val PROVIDER_STATUS_BETA_ONLY: Int = 3

PROVIDER_STATUS_DOWN

const val PROVIDER_STATUS_DOWN: Int = 0

PROVIDER_STATUS_KEY

const val PROVIDER_STATUS_KEY: String

PROVIDER_STATUS_OK

const val PROVIDER_STATUS_OK: Int = 1

PROVIDER_STATUS_SLOW

const val PROVIDER_STATUS_SLOW: Int = 2

USER_AGENT

const val USER_AGENT: String

Functions

addDate

fun Episode.addDate(date: Date?)

fun Episode.addDate(date: String?, format: String = "yyyy-MM-dd")

addDub

fun AnimeSearchResponse.addDub(episodes: Int?)

addDubStatus

fun AnimeSearchResponse.addDubStatus(status: DubStatus, episodes: Int? = null)

fun AnimeSearchResponse.addDubStatus(isDub: Boolean, episodes: Int? = null)

fun AnimeSearchResponse.addDubStatus(status: String, episodes: Int? = null)

fun AnimeSearchResponse.addDubStatus(dubExist: Boolean, subExist: Boolean, dubEpisodes: Int? = null, subEpisodes: Int? = null)

addEpisodes

fun AnimeLoadResponse.addEpisodes(status: DubStatus, episodes: List<Episode>?)

If episodes already exist appends the list.

addPoster

fun LoadResponse.addPoster(url: String?, headers: Map<String, String>? = null)

Extension function that adds poster to LoadResponse

fun SearchResponse.addPoster(url: String?, headers: Map<String, String>? = null)

Extension function that adds poster to SearchResponse

addQuality

fun SearchResponse.addQuality(quality: String)

Extension function that adds quality to SearchResponse

addSeasonNames

@JvmName(name = "addSeasonNamesSeasonData")

fun EpisodeResponse.addSeasonNames(names: List<SeasonData>)

@JvmName(name = "addSeasonNamesString")

fun EpisodeResponse.addSeasonNames(names: List<String>)

addSub

fun AnimeSearchResponse.addSub(episodes: Int?)

amap

suspend fun <A, B> List<A>.amap(f: suspend (A) -> B): List<B>

suspend fun <K, V, R> Map<out K, V>.amap(f: suspend (Map.Entry<K, V>) -> R): List<R>

Short for "Asynchronous Map", runs on all values concurrently, this means that if you are not doing networking, you should use a regular map

amapIndexed

suspend fun <A, B> List<A>.amapIndexed(f: suspend (index: Int, A) -> B): List<B>

Short for "Asynchronous Map" with an Index, runs on all values concurrently, this means that if you are not doing networking, you should use a regular mapIndexed

apmap

fun <A, B> List<A>.~~apmap~~(f: suspend (A) -> B): List<B>

fun <K, V, R> Map<out K, V>.~~apmap~~(f: suspend (Map.Entry<K, V>) -> R): List<R>

Short for "Asynchronous Parallel Map", but is not really parallel, only concurrent.

apmapIndexed

fun <A, B> List<A>.~~apmapIndexed~~(f: suspend (index: Int, A) -> B): List<B>

Short for "Asynchronous Parallel Map" with an Index, but is not really parallel, only concurrent.

argamap

fun <R> ~~argamap~~(vararg transforms: suspend () -> R): List<R?>

Short for "Argument Asynchronous Map" because it allows for a variadic number of paramaters.

base64Decode

fun base64Decode(string: String): String

Might need a different implementation for desktop

base64DecodeArray

fun base64DecodeArray(string: String): ByteArray

base64Encode

fun base64Encode(array: ByteArray): String

capitalizeString

fun capitalizeString(str: String): String

Capitalize the first letter of string.

capitalizeStringNullable

fun capitalizeStringNullable(str: String?): String?

Capitalize the first letter of string.

fetchUrls

fun fetchUrls(text: String?): List<String>

fixTitle

fun fixTitle(str: String): String

fixUrl

fun MainAPI.fixUrl(url: String): String

fixUrlNull

fun MainAPI.fixUrlNull(url: String?): String?

getDurationFromString

fun getDurationFromString(input: String?): Int?

getFolderPrefix

fun TvType.getFolderPrefix(): String

Extension function to get the folder prefix based on the TvType. Non-episode-based types will return a base folder name, while episode-based types will have their files placed in subfolders using a sanitized title name.

getId

fun IDownloadableMinimum.getId(): Int

getQualityFromString

fun getQualityFromString(string: String?): SearchQuality?

Returns SearchQuality from String.

getRhinoContext

suspend fun getRhinoContext(): Context

Get rhino context in a safe way as it needs to be initialized on the main thread.

imdbUrlToId

fun imdbUrlToId(url: String): String?

https://www.imdb.com/title/tt2861424/ -> tt2861424

imdbUrlToIdNullable

fun imdbUrlToIdNullable(url: String?): String?

https://www.imdb.com/title/tt2861424/ -> tt2861424

isAnimeBased

fun LoadResponse?.isAnimeBased(): Boolean

Extension function of LoadResponse to check if it's Anime based.

isAnimeOp

fun TvType.isAnimeOp(): Boolean

Extension function of TvType to check if the type has an Anime opening.

isAudioType

fun TvType.isAudioType(): Boolean

Extension function of TvType to check if the type is Audio.

isEpisodeBased

fun LoadResponse?.isEpisodeBased(): Boolean

Extension function of LoadResponse to check if it's Episode based.

fun TvType?.isEpisodeBased(): Boolean

Extension function to determine if the TvType is episode-based. This function checks if the type corresponds to an episode-based format. Episode-based types will be placed in subfolders that include the sanitized title name. This check is used for other logic as well.

isLiveStream

fun TvType.isLiveStream(): Boolean

Extension function of TvType to check if the type is Live stream.

isMovieType

fun TvType.isMovieType(): Boolean

Extension function of TvType to check if the type is Movie.

mainPage

fun mainPage(url: String, name: String, horizontalImages: Boolean = false): MainPageData

Create MainPageData from url, name Strings & layout (Horizontal/Vertical) Boolean.

mainPageOf

fun mainPageOf(vararg elements: MainPageData): List<MainPageData>

fun mainPageOf(vararg elements: Pair<String, String>): List<MainPageData>

return list of MainPageData with url to name, make for more readable code

newAnimeLoadResponse

suspend fun MainAPI.newAnimeLoadResponse( name: String, url: String, type: TvType, comingSoonIfNone: Boolean = true, initializer: suspend AnimeLoadResponse.() -> Unit = { }): AnimeLoadResponse

newAnimeSearchResponse

fun MainAPI.newAnimeSearchResponse( name: String, url: String, type: TvType = TvType.Anime, fix: Boolean = true, initializer: AnimeSearchResponse.() -> Unit = { }): AnimeSearchResponse

newEpisode

fun <T> MainAPI.newEpisode(data: T, initializer: Episode.() -> Unit = { }): Episode

fun MainAPI.newEpisode(url: String, initializer: Episode.() -> Unit = { }, fix: Boolean = true): Episode

newHomePageResponse

fun newHomePageResponse(list: HomePageList, hasNext: Boolean? = null): HomePageResponse

fun newHomePageResponse(list: List<HomePageList>, hasNext: Boolean? = null): HomePageResponse

fun newHomePageResponse(data: MainPageRequest, list: List<SearchResponse>, hasNext: Boolean? = null): HomePageResponse

fun newHomePageResponse(name: String, list: List<SearchResponse>, hasNext: Boolean? = null): HomePageResponse

newLiveSearchResponse

fun MainAPI.newLiveSearchResponse( name: String, url: String, type: TvType = TvType.Live, fix: Boolean = true, initializer: LiveSearchResponse.() -> Unit = { }): LiveSearchResponse

newLiveStreamLoadResponse

suspend fun MainAPI.newLiveStreamLoadResponse( name: String, url: String, dataUrl: String, initializer: suspend LiveStreamLoadResponse.() -> Unit = { }): LiveStreamLoadResponse

newMovieLoadResponse

suspend fun <T> MainAPI.newMovieLoadResponse( name: String, url: String, type: TvType, data: T?, initializer: suspend MovieLoadResponse.() -> Unit = { }): MovieLoadResponse

suspend fun MainAPI.newMovieLoadResponse( name: String, url: String, type: TvType, dataUrl: String, initializer: suspend MovieLoadResponse.() -> Unit = { }): MovieLoadResponse

newMovieSearchResponse

fun MainAPI.newMovieSearchResponse( name: String, url: String, type: TvType = TvType.Movie, fix: Boolean = true, initializer: MovieSearchResponse.() -> Unit = { }): MovieSearchResponse

newTorrentLoadResponse

suspend fun MainAPI.newTorrentLoadResponse( name: String, url: String, magnet: String? = null, torrent: String? = null, initializer: suspend TorrentLoadResponse.() -> Unit = { }): TorrentLoadResponse

newTorrentSearchResponse

fun MainAPI.newTorrentSearchResponse( name: String, url: String, type: TvType = TvType.Torrent, fix: Boolean = true, initializer: TorrentSearchResponse.() -> Unit = { }): TorrentSearchResponse

newTvSeriesLoadResponse

suspend fun MainAPI.newTvSeriesLoadResponse( name: String, url: String, type: TvType, episodes: List<Episode>, initializer: suspend TvSeriesLoadResponse.() -> Unit = { }): TvSeriesLoadResponse

newTvSeriesSearchResponse

fun MainAPI.newTvSeriesSearchResponse( name: String, url: String, type: TvType = TvType.TvSeries, fix: Boolean = true, initializer: TvSeriesSearchResponse.() -> Unit = { }): TvSeriesSearchResponse

runAllAsync

suspend fun <R> runAllAsync(vararg transforms: suspend () -> R): List<R?>

Runs all different functions at the same time and awaits for all to be finished, then returns a list of all those items or null if they fail. However Unit is often used.

sortUrls

fun sortUrls(urls: Set<ExtractorLink>): List<ExtractorLink>

Sort the urls based on quality

toRatingInt

fun String?.toRatingInt(): Int?

updateUrl

fun MainAPI.updateUrl(url: String): String

For APIs using the mainUrl in the prefix for MainAPI::load, this function replaces the scheme, host and port from an old link to the new mainUrl.