Skip to main content

iOS SDK

Learn how to implement the Eyeson features in a native iOS app.

info

The Eyeson iOS SDK acts as a communication client for an existing meeting room.

Prerequisites​

warning

To get Eyeson running on iOS you will need to have a valid meeting accessKey or guestToken from a running room instance.

The respective credentials can be obtained from the API with a valid API key. Thus, an additional backend webservice to host and maintain Eyeson meetings is mandatory from your side. See API documentation for more information.

Examples​

You will find an example app in the main branch of the git repository. Install the Swift Package as described above to get everything up and running.

Simulator Runs​

danger

Not all features are working properly in Simulator runs, like Screencast, Picture in Picture, etc. Always test your implementation on a real device.

Add Eyeson to your Xcode project​

The SDK is available via Swift Package Manager.

Configuration​

Info.plist

It's mandatory to add

  • NSMicrophoneUsageDescription
  • NSCameraUsageDescription

to your Info.plist otherwise your app will crash.

Background Modes​

To run your application in background, enable the following Background Modes in your Signing & Capabilities:

Background Modes
  • Voice over IP
  • Audio, AirPlay, and Picture in Picture

Usage​

import EyesonSdk