Creating a provider#

This guide assumes you've already configured a TestProvider module in the providers folder and added it to settings.gradle.kts.

The recommended architecture is capability-based:

• Your entry class extends ProviderPlugin.
• You expose one or more capability APIs (search, catalogs, metadata, links, etc.).

ProviderApi and getApi() still exist for backward compatibility, but they’re deprecated.

Provider project structure#

As noted in the "Creating a custom provider" step, your project structure follows a standard Kotlin/Java Gradle module setup:

TestProvider/
├── build.gradle.kts            # Provider-specific build configuration
├── src/
│   └── main/
│       ├── kotlin/             # Your provider's source code
│       │   └── com/
│       │       └── example/
│       │           └── testProvider/
│       │               └── TestProvider.kt
│       └── res/                # Resources (if needed)
└── README.md                   # Provider-specific documentation (optional)

Ensure that the TestProvider project—or any provider you create—follows this structure within the providers folder.

Creating the entry class (ProviderPlugin)#

The provider entry class is what the app loads at runtime.

The core stubs library is well-documented — hover any symbol from core-stubs to read its KDoc.

To create a new provider entry class:

import com.flixclusive.provider.FlixclusiveProvider
import com.flixclusive.provider.ProviderPlugin
// ...
 
@FlixclusiveProvider
class TestProvider : ProviderPlugin() {
    // ...
}

import android.content.Context
import com.flixclusive.provider.ProviderPlugin
import com.flixclusive.provider.capability.SearchProviderApi
import com.flixclusive.provider.capability.MediaLinkProviderApi
// ...
 
class TestProvider : ProviderPlugin() {
    private val searchApi by lazy {
        TestProviderSearchProviderApi(
            providerId = manifest.id,
        )
    }
 
    private val mediaLinkApi by lazy {
        TestProviderMediaLinkProviderApi(
            providerId = manifest.id,
        )
    }
 
    override fun getSearchApi(context: Context): SearchProviderApi = searchApi
 
    override fun getMediaLinkApi(context: Context): MediaLinkProviderApi = mediaLinkApi
}

For detailed signatures, see the ProviderPlugin API reference.

Implementing the capability APIs#

Each capability is a focused interface. Implement only what your provider supports.

Optional: legacy ProviderApi#

ProviderApi can still be used (and some older examples still reference it), but it is deprecated. Prefer capability APIs for new providers.

Final output#

At runtime, your provider should appear in the app’s provider list.

Lastly, deploy the provider to the app using the following command:

./gradlew :TestProvider:deployWithAdb

After successful deployment, your provider should appear in the app's provider list.