This SDK makes it easy to upload videos for ingest to Mux from an iOS or iPadOS application. It handles large files by breaking them into chunks and uploading each chunk individually.
Each video is uploaded to an authenticated upload URL created by a trusted backend server request to the Mux Video API. Do not include the secret API credentials to create an authenticated upload URL in your application.
To use this SDK, add it as a dependency using either Swift Package Manager or CocoaPods.
The Upload SDK supports iOS 15 and iPadOS 15 or later. macOS is not supported at this time.
See Upload video directly from iOS or iPadOS for the complete integration guide.
If you haven't yet done so, create an access token for your trusted environment.
To start an upload, create a Direct Upload there and provide its authenticated PUT URL to your app. Never embed your Mux access token ID or secret key in a production app.
Add our SDK as a package dependency to your Xcode project.
The Swift Package Manager is a tool for managing the distribution of Swift code. It's integrated with Xcode and the Swift build system to automate the process of downloading, compiling, and linking dependencies.
Step-by-step guide on using Swift Package Manager in Xcode. Our repository URL (for the 'search' field in the upper corner) is https://github.com/muxinc/swift-upload-sdk.
CocoaPods is a dependency manager for Xcode projects. See the CocoaPods usage instructions.
To integrate our SDK into your Xcode project using CocoaPods, specify it in your Podfile:
pod 'Mux-Upload-SDK'Pass the authenticated Direct Upload URL and a local video file URL to the SDK. Keep a strong reference to the upload while it is running if your app needs to control it later.
import Foundation
import MuxUploadSDK
final class UploadCoordinator {
private var upload: DirectUpload?
func startUpload(uploadURL: URL, videoFileURL: URL) {
let upload = DirectUpload(
uploadURL: uploadURL,
inputFileURL: videoFileURL
)
upload.progressHandler = { state in
guard let progress = state.progress else { return }
print("Uploaded \(progress.completedUnitCount) / \(progress.totalUnitCount)")
}
upload.resultHandler = { [weak self] result in
switch result {
case .success:
print("Upload succeeded")
case .failure(let error):
print("Upload failed: \(error.localizedDescription)")
}
self?.upload = nil
}
self.upload = upload
upload.start()
}
}Input standardization is enabled by default and is best effort. The SDK uploads compliant H.264 and HEVC inputs without re-encoding them. When local inspection, conversion, or validation cannot complete, the SDK uploads the original input by default so that Mux can process it.
The default maximum resolution is 1920 x 1080 (1080p), and eligible HDR input is preserved. To prepare video up to 3840 x 2160 (2160p/4K), provide custom options:
import MuxUploadSDK
let options = DirectUploadOptions(
inputStandardization: .init(
maximumResolution: .preset3840x2160,
hdrHandling: .preserve
)
)Selecting 1440p or 2160p in the SDK controls the file prepared on the device. When your trusted environment creates the Direct Upload, also set new_asset_settings.max_resolution_tier to the matching "1440p" or "2160p" tier.
Preserving HDR does not guarantee end-to-end HDR playback. To create BT.709 SDR output on the device for supported HDR inputs, explicitly select .toneMapToSDR. See the integration guide for supported behavior, fallback handling, and examples.
A sample app showing input-standardization configuration, PhotosPicker integration, upload progress, cancellation, and managed-upload restoration is available in Example/SwiftUploadSDKExample.
This SDK is a Swift package that can be opened by Xcode. To edit it, clone this repository and open the root folder in Xcode.
Run or edit the sample app by opening Example/SwiftUploadSDKExample/SwiftUploadSDKExample.xcodeproj.
Maintainer release instructions live in RELEASING.md.