Player SDK for iOS

The FastPix iOS Player SDK is a flexible solution for integrating .m3u8 video streaming into your iOS applications. Whether you're streaming live broadcasts or on-demand content, the SDK provides playback with support for secure token-based access, custom domains, resolution control, and audio track switching. Once your video upload reaches the ready status, a stream URL is generated—paired with a unique playback ID—to deliver a smooth viewing experience with minimal configuration.

Initial Setup

To get started with the FastPix Player SDK, follow these steps:

• Log in to the FastPix Dashboard: Navigate to the FastPix-Dashboard and log in with your credentials.
• Create Media: Start by creating a media using a pull or push method. You can also use our APIs for Push media or Pull media.
• Retrieve Media Details: After creation, access the media details by navigating to the "View Media" page.
• Get Playback ID: From the media details, obtain the playback ID.
• Play Video: Use the playback ID in the FastPix-player to play the video seamlessly.

Explore our detailed guide to upload videos and getting a playback ID using FastPix APIs

Installation

To install the SDK, you can use Swift Package Manager(SPM) :

How to use Swift Package Manager

The Swift Package Manager is a tool that simplifies the distribution and management of Swift code, seamlessly integrating with Xcode and the Swift build system to streamline downloading, compiling, and linking dependencies.

Here’s a quick guide for adding our package to your Xcode project Step-by-step guide on using Swift Package Manager in Xcode.

To get started, use the repository URL in Xcode's search field: "https://github.com/FastPix/iOS-player".

Import

import FastPixPlayerSDK

Features of iOS Player SDK

FastPix iOS Player SDK supports all the features mentioned below, ensuring easy integration, enhanced playback performance, and a customizable streaming experience for iOS applications.

Click here for a detailed overview.

##Media Playback:

With FastPix iOS Player you can play live and on-demand videos using streamType and playbackID.

For on-demand videos:

// create an object of AVPlayerViewController()  

lazy var playerViewController = AVPlayerViewController() 

// play the videos using playbackID and streamType is set to on-demand

playerViewController.prepare(playbackID: playbackID,playbackOptions: PlaybackOptions(streamType: "on-demand"))

For live-stream videos:

// play the videos using playbackID and streamType is set to live

playerViewController.prepare(playbackID: playbackID,playbackOptions: PlaybackOptions(streamType: "live")) 

##Secure Playback:

In FastPix Player you can ensure content security with token-based authentication, secure playback IDs, and HTTPS support for both live and on-demand streams.You can give playbackToken using parameter "playbackToken"

For live-stream videos:

// play the videos using playbackID,playbackToken and streamType is set to live

playerViewController.prepare(playbackID: playbackID, playbackOptions: PlaybackOptions(streamType: "live",playbackToken: playbackToken))

For on-demand videos:

// play the videos using playbackID,playbackToken and streamType is set to on-demand

playerViewController.prepare(playbackID: playbackID, playbackOptions: PlaybackOptions(streamType: "on-demand",playbackToken: playbackToken)) 

##Custom Domains:

With the FastPix iOS Player SDK, you can stream videos from your own custom domain, whether you're serving public content or securing private videos using playback tokens. This flexible setup allows you to maintain and optimize performance, control access to your media with minimal configuration.You can set your customDomain with parameter "customDomain"

For on-demand videos:

// play the videos with custom Domain, playbackID, playbackToken and streamType is set to on-demand

playerViewController.prepare(playbackID: playbackID, playbackOptions: PlaybackOptions(customDomain: "customDomain", playbackToken: playbackToken, streamType: "on-demand")) 

For live-stream videos:

// play the videos with custom Domain, playbackID, playbackToken and streamType is set to live

playerViewController.prepare(playbackID: playbackID, playbackOptions: PlaybackOptions(customDomain: "customDomain", streamType: "live")) 

##Audio Track Switching:

• Allow users to dynamically switch between audio tracks during playback, perfect for multi-language or additional audio options.

• The FastPix iOS Player automatically detects and displays all available audio track options, If the playback supports or is integrated with multiple audio tracks simplifying the implementation process for dynamic audio switching.

##Resolution Control:

FastPix iOS Player allows you to configure playback resolution, including minimum, maximum, specific, and range-based resolutions for optimized streaming.

Option	Description	Available Values	Default
minResolution	Sets the minimum resolution for playback to avoid loading low-quality streams. Helps maintain baseline video quality.	.atLeast270p, .atLeast360p, .atLeast480p, .atLeast540p, .atLeast720p, .atLeast1080p, .atLeast1440p, .atLeast2160p	.standard
maxResolution	Sets the maximum resolution to prevent very high-quality playback. Useful to control bandwidth or reduce buffering.	.upTo270p, .upTo360p, .upTo480p, .upTo540p, .upTo720p, .upTo1080p, .upTo1440p, .upTo2160p	.standard
resolution	Forces a specific fixed resolution regardless of network quality. Disables adaptive playback. Best used for demos or testing.	.set270p, .set360p, .set480p, .set540p, .set720p, .set1080p, .set1440p, .set2160p	.standard
renditionOrder	Controls how resolution renditions are prioritized. Useful for customizing the adaptive strategy.	.standard, .descending	.standard

###Play with a Minimum Resolution:

// play videos with custom min-resolution and playbackID 

playerViewController.prepare(playbackID: playbackID, playbackOptions: PlaybackOptions(minResolution : .atLeast270p)) 

// play videos with custom min-resolution, playbackID and playbackToken 

playerViewController.prepare(playbackID: playbackID, playbackOptions: PlaybackOptions(minResolution : .atLeast270p, playbackToken: playbackToken)) 

###Play with a Maximum Resolution:

// play videos with custom max-resolution and playbackID  

playerViewController.prepare(playbackID: playbackID, playbackOptions: PlaybackOptions(maxResolution : .upTo1080p)) 

// play videos with custom max-resolution, playbackID and playbackToken 

playerViewController.prepare(playbackID: playbackID, playbackOptions: PlaybackOptions(maxResolution : .upTo1080p, playbackToken: playbackToken))

###Play with a Custom Resolution:

// play videos with a specific resolution, playbackID and playbackToken 

playerViewController.prepare(playbackID: playbackID, playbackOptions: PlaybackOptions(resolution : .set480p, playbackToken: playbackToken))

// play videos with in a specific range of resolution playbackID  and  playbackToken 

playerViewController.prepare(playbackID: playbackID, playbackOptions: PlaybackOptions(minResolution : .atLeast270p, maxResolution : .upTo1080p ,playbackToken: playbackToken)) 

##Rendition Order Customization:

With the FastPix iOS Player SDK, you can configure resolution selection priorities to deliver an optimized viewing experience to user preferences.

// play videos with in a  specific range of resolution playbackID  and  renditionOrder 

playerViewController.prepare(playbackID: playbackID, playbackOptions: PlaybackOptions(minResolution :  (example :  .atLeast270p) ,maxResolution : (example :  .upTo1080p ,renditionOrder:  .descending )) 

####Each of these features is designed to enhance both flexibility and user experience, providing complete control over video playback, appearance, and user interactions in FastPix-player.

Development

Maturity

This SDK is currently in beta, and breaking changes may occur between versions even without a major version update. To avoid unexpected issues, we recommend pinning your dependency to a specific version. This ensures consistent behavior unless you intentionally update to a newer release.