Mux Upload SDK/com.mux.video.upload/MuxUploadSdk

MuxUploadSdk

object MuxUploadSdk

This object allows you to get version info, enable logging, override the HTTP client, etc

Before using the SDK, you must call initialize.

Types

interface Logger

Logs events from this SDK. This interface roughly matches the interface of Log.

Functions

fun initialize(appContext: Context, resumeStoppedUploads: Boolean = true)

Initializes the SDK with the given Context. The Context instance isn't saved.

fun logcatLogger(): MuxUploadSdk.Logger

Creates a new Logger that logs to android logcat

fun noLogger(): MuxUploadSdk.Logger

Creates a new Logger that produces no output. It does nothing and discards all input. This is the default logger.

systemOutLogger

fun systemOutLogger(): MuxUploadSdk.Logger

Creates a new Logger that logs to System.out. Useful for unit test environments, where Log doesn't work

fun useLogger(logger: MuxUploadSdk.Logger)

Use the specified logger for logging events in this SDK. This SDK produces no logs by default. If you need to debug your integration, you can add a logcatLogger or systemOutLogger or implement your own Logger for logging libs like Timber or Firebase Crashlytics

useOkHttpClient

fun useOkHttpClient(okHttpClient: OkHttpClient)

Use the specified OkHttpClient instead of the default internal okhttp client

Properties

val logger: MuxUploadSdk.Logger

Logs messages from the SDK. By default, no logging is performed To get logs from this SDK, use useLogger, eg:

const val VERSION: <Error class: unknown class>

The current version of the SDK. Release builds of this SDK follow semver (https://semver.org)