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

UploadStatus

sealed class UploadStatus

The current state of the upload. Uploads are first examined, potentially processed, then uploaded to Mux Video.

Inheritors

Constructors

Link copied to clipboard
protected constructor()

Types

Link copied to clipboard
data object Preparing : UploadStatus

This upload is being prepared. If standardization is required, it is done during this step

Link copied to clipboard
data object Ready : UploadStatus

This upload hos not been started. It is ready to start by calling MuxUpload.start

Link copied to clipboard
data object Started : UploadStatus

This upload has been started via MuxUpload.start but has not yet started processing anything

Link copied to clipboard
class UploadFailed(val exception: Exception, val uploadProgress: MuxUpload.Progress) : UploadStatus

The upload has failed. Part of the file may have already been uploaded, and this upload can be resumed from this state via MuxUpload.start

Link copied to clipboard
class Uploading(val uploadProgress: MuxUpload.Progress) : UploadStatus

The upload is currently being sent to Mux Video. The progress is available

Link copied to clipboard
class UploadPaused(val uploadProgress: MuxUpload.Progress) : UploadStatus

The upload is currently paused. Part of the video file may have already been uploaded to Mux Video, but no data is currently being sent

Link copied to clipboard
class UploadSuccess(val uploadProgress: MuxUpload.Progress) : UploadStatus

The upload succeeded. The file has been uploaded to Mux Video and will be processed shortly

Functions

Link copied to clipboard
open fun getError(): Exception?

If this upload failed, returns the error that caused the failure

Link copied to clipboard
open fun getProgress(): MuxUpload.Progress?

The progress, in bytes, of the upload. If the file isn't uploading yet, this will be null.

Link copied to clipboard
fun isSuccessful(): Boolean

Returns whether or not the uplod was successful