Mux Upload SDK/com.mux.video.upload.api/MuxUpload

MuxUpload

Represents an upload of a video as a Mux Video asset. In order to use this SDK, you must first create a direct upload server-side, then return that direct upload PUT URL to your app.

Once you have a PUT URL, you can create and start your upload using the Builder

For example:

// Start a new upload
val upload = MuxUpload.Builder(myUploadUrl, myInputFile).build()
upload.setResultListener { myHandleResult(it) }
upload.setProgressListener { myHandleProgress(it) }
upload.start()

For full documentation on how to configure your upload, see the Builder

Types

Builder

class Builder(val uploadUri: Uri, val videoFile: File)

Builds instances of MuxUpload.

Progress

data class Progress(val bytesUploaded: Long = 0, val totalBytes: Long = 0, val startTime: Long = 0, val updatedTime: Long = 0)

The current progress of an upload, in terms of time elapsed and data transmitted

Functions

awaitSuccess

suspend fun awaitSuccess(): Result<UploadStatus>

If the upload has not succeeded, this function will suspend until the upload completes and return the result

cancel

fun cancel()

Cancels this upload. The upload job will be canceled and it will not be possible to start this job again where it left off

clearListeners

@MainThread

fun clearListeners()

Clears all listeners set on this object

pause

fun pause()

Pauses the upload. If the upload was already paused, this method has no effect

setProgressListener

@MainThread

fun setProgressListener(listener: UploadEventListener<MuxUpload.Progress>?)

Sets a listener for progress updates on this upload

setResultListener

@MainThread

fun setResultListener(listener: UploadEventListener<Result<MuxUpload.Progress>>?)

Sets a listener for success or failure updates on this upload

setStatusListener

@MainThread

fun setStatusListener(listener: UploadEventListener<UploadStatus>?)

Set a listener for the overall status of this upload.

start

@JvmOverloads

fun start(forceRestart: Boolean = false)

Starts this Upload. You don't need to hold onto this object in order for the upload to complete, it will continue in parallel with the rest of your app. You can always get a handle to an ongoing upload by using MuxUploadManager.findUploadByFile