Overview

iOS

You are able to integrate FASP into your iOS applications. The Aspera iOS SDK provides an Objective-C API to transfer files using FASP. You are able to build your iOS application anyway you like while integrating FASP into it using the framework file. This guide will show you how to get started and develop your application.

 


Guides

Getting Started

Downloads

 iOS SDK 3.7.0iOS SDK 3.7.0

 iOS SDK 3.6.3iOS SDK 3.6.3

 iOS SDK 3.6.1iOS SDK 3.6.1

 iOS SDK 3.5.0.104555iOS SDK 3.5.0.104555

iOS 3.7.0 Changes

What's new

  • updated fasp to 3.7.4.145477
  • added http fallback support
  • fixed crash and additional bug with [session stop]
  • switched target rates to use ASTargetRate instances rather than unsigned long long
  • the macOS SDK no longer requires a mobile-enabled remote server

Upgrading from 3.6.x to 3.7.0

  • Make note the location of AsperaSDK.framework in use by the project (right-clicking the framework in XCode and choosing 'Show in Finder')
  • Close the Project in Xcode
  • Replace the previous AsperaSDK.framework with the new one obtained from the 3.6.3 download link above
  • Update all methods calls that get/set the target rate to use ASTargetRate instances. Previous versions used unsigned long long values in bits-per-second (bps) to represent target rates whereas starting with 3.7.0 the SDK uses ASTargetRate instances to represent target rates. An ASTargetRate instance may be created using [TargetRate rate:.. units:ASRateUnitKbps]; in Objective-C or TargetRate(rate:.., units:.kbps) in Swift.
  • Reopen the project and select Product > Clean in the Mac menu bar
  • Future builds of your project will now build against version 3.6.3 of the Aspera SDK for iOS

iOS 3.6.3 Changes

This next generation SDK for iOS provides an improved and simplified API for transferring files to and from iOS devices. The API has been redesigned and is not backwards compatible with the 3.5.0 SDK. Features include:

  • a simpler, cleaner API for transferring files
  • regular and persistent sessions
  • support for fasp protocol v3.6.1

New in 3.6.2

  • ipv6/nat64 support, including ipv6 address synthesis for ipv4 addresses over ipv6 networks
  • bitcode is included in the ios framework
  • improved installation instructions to address common issues
  • swift snippets in the documentation alongside objc
  • debug symbols are stripped from the iOS SDK (prevents 200+ warnings)
  • added a swift3 sample and an OS X sample

Getting Started Guide

You will need to install Xcode on your Mac computer.  You can do this by simply:

  • Launching the Mac App Store application
  • Searching for Xcode or using this direct link
  • Install Xcode, after first launch the installer will finish

Now that you have Xcode installed you can simply create a project or open a project and add the Aspera SDK to your project.  To do this you will need to:

  • Download the SDK using the links above
  • Extract the AsperaSDK.framework file
  • Drag and drop it to your XCode project
  • Select “Copy items if needed”

Upgrading from 3.6.0/3.6.1/3.6.2 to 3.6.3

  • Make note the location of AsperaSDK.framework in use by the project (right-clicking the framework in XCode and choosing 'Show in Finder')
  • Close the Project in Xcode
  • Replace the previous AsperaSDK.framework with the new one obtained from the 3.6.3 download link above
  • Reopen the project and select Product > Clean in the Mac menu bar
  • Future builds of your project will now build against version 3.6.3 of the Aspera SDK for iOS

Upgrading to 3.6.0

The API in version 3.6.0 has been redesigned and is not backwards compatible with the API in 3.5.0 or earlier versions, changes will be necessary to the code in order to upgrade to 3.6.0. The most significant change is the absence of a transfer queue in version 3.6.0; applications are now responsible for managing their own transfer queues. For the precise details on how to create and start a transfer session please consult the 3.6.0 documentation.

Upgrading to 3.5.0

  • Make note the location of AsperaMobile.framework in use by the project (right-clicking the framework in XCode and choosing 'Show in Finder')
  • Close the Project in Xcode
  • Replace the previous version with the new one using the download link above
  • Reopen the project and select Product > Clean in the Mac menu bar
  • This will allow future builds to build against the new new version of the SDK.

 


API Documentation

 


Examples

iOS 3.6.2 Example

 Objective-C

 Swift 2.2

 Swift 3

 OSX

iOS 3.6.1 Example

 Objective-C

 Swift 2.2

 Swift 3

 OSX

iOS 3.6 Example

Simple Transfer

 3.6 Sample Application (Objective-C)

 3.6 Sample Application (Swift)

This example provides a working project that shows a minimal interface for initiating a transfer using the iOS SDK.

iOS 3.5 Examples

simple-queue2With iOS applications you can create any type of application with any look or style that you like, to help you get started integrating Aspera technologies into your iOS application we have created a basic Transfer and Queue example.  These are baritone examples that demonstrate initiating transfers in an iOS application and creating a queue and displaying it in the application.  Due to the multi file nature of iOS applications, we have put these examples in a ZIP file.  You can simply download, extract and open the xcodeproj file to open the project in Xcode.  Remember that you need to import the SDK, for more information on this please see the Getting Started section.

Swift examples are provided below, however, these are experimental.  The instructions for building the Swift examples are basically the same as the Objective-C, however, the .m file should be changed to .swift.

Simple Queue

 Download SimpleQueue (Objective-C)

 Download SimpleQueue (Swift)

 Download SimpleQueue (Xcode 4 and Earlier)

This example provides a working project that shows a minimal queue interface that allows for uploading and downloading from one Aspera Server that is hard coded into the application.  The code in this project implements a queue as a convenient task to demonstrate several aspects of using the Aspera Mobile SDK.  Since Version 3.0.0 the AsperaMobile SDK provides a rich queue UI that can be easily added to any application.

To run this example you need to change the ApplicationSetting.m file and replace the placeholder values for the account configuration with your configurations of the server you are going to use.

Simple Transfer

 Download SimpleTransfer (Objective-C)

 Download SimpleTransfer (Swift)

 Download SimpleTransfer (Xcode 4 and Earlier)

This example provides a working project that shows a minimal interface with two buttons; one that launches an upload to a server that has been hard coded in and a second button that shows the queue.

The AppDelegate.m file initializes the SDK contains the configuration, the ViewController.m file creates and queues the transfer session and the QueueDelegate.m file handles the queue events.  To run this example you need to change the ApplicationSetting.m file and replace the placeholder values for the account configuration with your configurations of the server you are going to use.

 


Video player

Video

×