Cloudstream/com.lagradost.cloudstream3

Package-level declarations

Types

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

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

ActorRole

enum ActorRole : Enum<ActorRole>

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

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

AniSearch

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

APIHolder

object APIHolder

AutoDownloadMode

enum AutoDownloadMode : Enum<AutoDownloadMode>

CommonActivity

object CommonActivity

CustomReportSender

class CustomReportSender

CustomSenderFactory

class CustomSenderFactory

DownloaderTestImpl

class DownloaderTestImpl : Downloader

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

ErrorLoadingException

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

ExceptionHandler

class ExceptionHandler(val errorFile: File, val onError: () -> Unit) : Thread.UncaughtExceptionHandler

FocusDirection

enum FocusDirection : Enum<FocusDirection>

HomePageList

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

HomePageResponse

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

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, val lang: String? = null) : SearchResponse

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

LoadResponse

interface LoadResponse

MainActivity

class MainActivity : BiometricAuthenticator.BiometricCallback

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

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

NextAiring

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

ProvidersInfoJson

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

ProviderType

enum ProviderType : Enum<ProviderType>

SearchQuality

enum SearchQuality : Enum<SearchQuality>

SearchResponse

interface SearchResponse

SeasonData

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

SettingsJson

data class SettingsJson(var enableAdult: Boolean = false)

ShowStatus

enum ShowStatus : Enum<ShowStatus>

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)

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

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

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)

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

TvSeriesSearchResponse

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

TvType

enum TvType : Enum<TvType>

VPNStatus

enum VPNStatus : Enum<VPNStatus>

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)

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

addQuality

fun SearchResponse.addQuality(quality: String)

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>

amapIndexed

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

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>

apmapIndexed

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

argamap

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

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

capitalizeStringNullable

fun capitalizeStringNullable(str: String?): 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?

getId

fun IDownloadableMinimum.getId(): Int

getQualityFromString

fun getQualityFromString(string: String?): SearchQuality?

Add anything to here if you find a site that uses some specific naming convention

getRhinoContext

suspend fun getRhinoContext(): Context

Get rhino context in a safe way as it needs to be initialized on the main thread. Make sure you get the scope using: val scope: Scriptable = rhino.initSafeStandardObjects() Use like the following: rhino.evaluateString(scope, js, "JavaScript", 1, null)

imdbUrlToId

fun imdbUrlToId(url: String): String?

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

imdbUrlToIdNullable

fun imdbUrlToIdNullable(url: String?): String?

isAnimeBased

fun LoadResponse?.isAnimeBased(): Boolean

isAnimeOp

fun TvType.isAnimeOp(): Boolean

isEpisodeBased

fun LoadResponse?.isEpisodeBased(): Boolean

fun TvType?.isEpisodeBased(): Boolean

isLiveStream

fun TvType.isLiveStream(): Boolean

isMovieType

fun TvType.isMovieType(): Boolean

mainPage

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

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

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

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

setHeaderDecoration

fun setHeaderDecoration(view: <Error class: unknown class>, @LayoutRes headerViewRes: Int)

sortUrls

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

toRatingInt

fun String?.toRatingInt(): Int?