OkHttpDataSourceFactory


@UnstableApi
class OkHttpDataSourceFactory : HttpDataSource.BaseFactory


Summary

Public constructors

Creates an instance.

OkHttpDataSourceFactory(callFactory: Call.Factory!, userAgent: String?)

Creates an instance.

OkHttpDataSourceFactory(
    callFactory: Call.Factory!,
    userAgent: String?,
    cacheControl: CacheControl?
)

Creates an instance.

OkHttpDataSourceFactory(
    callFactory: Call.Factory!,
    userAgent: String?,
    listener: TransferListener?
)

Creates an instance.

OkHttpDataSourceFactory(
    callFactory: Call.Factory!,
    userAgent: String?,
    listener: TransferListener?,
    cacheControl: CacheControl?
)

Creates an instance.

Protected functions

OkHttpDataSource!
createDataSourceInternal(
    defaultRequestProperties: HttpDataSource.RequestProperties!
)

Called by createDataSource to create a HttpDataSource instance.

Inherited functions

From androidx.media3.datasource.DataSource.Factory
abstract DataSource!

Creates a DataSource instance.

From androidx.media3.datasource.HttpDataSource.BaseFactory
HttpDataSource!

Creates a DataSource instance.

HttpDataSource.Factory!
@CanIgnoreReturnValue
setDefaultRequestProperties(
    defaultRequestProperties: (Mutable)Map<String!, String!>!
)

Sets the default request headers for HttpDataSource instances created by the factory.

Public constructors

OkHttpDataSourceFactory

OkHttpDataSourceFactory(callFactory: Call.Factory!)

Creates an instance.

Parameters
callFactory: Call.Factory!

A Call.Factory (typically an okhttp3.OkHttpClient) for use by the sources created by the factory.

OkHttpDataSourceFactory

OkHttpDataSourceFactory(callFactory: Call.Factory!, userAgent: String?)

Creates an instance.

Parameters
callFactory: Call.Factory!

A Call.Factory (typically an okhttp3.OkHttpClient) for use by the sources created by the factory.

userAgent: String?

An optional User-Agent string.

OkHttpDataSourceFactory

OkHttpDataSourceFactory(
    callFactory: Call.Factory!,
    userAgent: String?,
    cacheControl: CacheControl?
)

Creates an instance.

Parameters
callFactory: Call.Factory!

A Call.Factory (typically an okhttp3.OkHttpClient) for use by the sources created by the factory.

userAgent: String?

An optional User-Agent string.

cacheControl: CacheControl?

An optional CacheControl for setting the Cache-Control header.

OkHttpDataSourceFactory

OkHttpDataSourceFactory(
    callFactory: Call.Factory!,
    userAgent: String?,
    listener: TransferListener?
)

Creates an instance.

Parameters
callFactory: Call.Factory!

A Call.Factory (typically an okhttp3.OkHttpClient) for use by the sources created by the factory.

userAgent: String?

An optional User-Agent string.

listener: TransferListener?

An optional listener.

OkHttpDataSourceFactory

OkHttpDataSourceFactory(
    callFactory: Call.Factory!,
    userAgent: String?,
    listener: TransferListener?,
    cacheControl: CacheControl?
)

Creates an instance.

Parameters
callFactory: Call.Factory!

A Call.Factory (typically an okhttp3.OkHttpClient) for use by the sources created by the factory.

userAgent: String?

An optional User-Agent string.

listener: TransferListener?

An optional listener.

cacheControl: CacheControl?

An optional CacheControl for setting the Cache-Control header.

Protected functions

createDataSourceInternal

protected fun createDataSourceInternal(
    defaultRequestProperties: HttpDataSource.RequestProperties!
): OkHttpDataSource!

Called by createDataSource to create a HttpDataSource instance.

Parameters
defaultRequestProperties: HttpDataSource.RequestProperties!

The default RequestProperties to be used by the HttpDataSource instance.

Returns
OkHttpDataSource!

A HttpDataSource instance.