Skip to main content
Skip table of contents

Apple (FPS) SDK 5 Example Code Quick Start

This guide enables you to demonstrate CONNECT Player features and view the example code.

Example code is provided for iOS only.

Prerequisites

Make sure you have the latest version of Xcode installed.

Download the iOS SDK, which supplies all the files needed to launch the player and start streaming content.

  • opy-sdk-ios-fps-5.10.x-example-code.zip
    This file contains application projects that demonstrate how to use simple and advanced features, such as playing clear and encrypted streams.

  • opy-sdk-ios-fps-5.10.x-integration.zip
    This contains the SDK framework files.

  • opy-sdk-ios-fps-5.10.x-xcframework-integration.zip
    This contains the SDK xcframework file.

You also need a device running iOS 12 or above.

Procedure

  1. Save the SDK pack to your development machine and unzip it. The extracted package contains a zipped set of example code; extract the contents of the example-code.zip file to a suitable location.

  2. Copy the SDK framework & xcframework folder into the example-code folder.

  3. Start Xcode, and then select the required project from the extracted package; see the example projects below.

  4. Connect an Apple device to your machine, and build and run the application.

Click here to see the example projects available.

Playback

basic-playback

Demonstrates playback of a clear HLS stream with no additional functionality.

basic-playback-xcframework

Demonstrates playback of a clear HLS stream with no additional functionality using SDK xcframework.

low-latency

Playback of low-latency HLS streams.

container-view

Manages the view hierarchy for standard playback.

resolution-capping

Playback of clear HLS streams with resolution capping.

objective-c support

Code development using Objective-C.

thumbnail-seeking-webvtt

Playback of clear HLS streams with webvtt thumbnail previews.

thumbnail-seeking-iframe

Playback of clear HLS streams with iFrame thumbnail previews.

track-selection

Playback of clear HLS streams with multiple audio tracks and subtitles.

Encrypted playback

encrypted-playback-simple

Integration using a convenient delegate to support Playback of FPS encrypted content.

encrypted-playback-advanced

Integration using low-level license delegate to support Playback of FPS encrypted content.

encrypted-playback-ssm

Playback of FPS encrypted content with Secure Session Management (SSM).

encrypted-playback-advanced-ssm

Integration using low-level license delegate to support playback of FPS encrypted content with SSM.

customer-ssm

Provides a solution for customers to handle SSM.

encrypted-playback-binary

 Playback of FPS encrypted content but the network request for decryption returns binary data.

encrypted-playback-tokenCallback

Playback of FPS encrypted content using token callbacks.

Offline playback

offline-playback

Offline playback of clear and encrypted HLS streams.

offline-encrypted

Downloads an encrypted HLS stream while requesting a licence and then plays offline content.

offline-license-predelivered

Prefetches the licence before downloading an encrypted HLS stream and playing offline content.

offline-license-renewal

Downloads an encrypted HLS stream, obtains the licence, plays the offline content and Renews the licence when a licence expiry error is received.

minimumbitrate-for-offline

Select the minimum bitrate to download for offline playback.

minimumresolution-for-offline

Select the minimum resolution to download for offline playback. (Only available for iOS 14 and above).

offline-prepare-download

Select the download stream before downloading starts.

drm-token-passing

Parse the SSP DRM stream token to get the licence duration and set it to offline content. 

Content security

quickmark-pull-mode

Demonstrates QuickMark forensic watermarking in pull mode.

quickmark-push-mode

Demonstrates QuickMark forensic watermarking in push mode.

Advertising

dynamic-ads-ima

Playback of clear HLS streams with Google IMA adverts. Pod install is required to generate the XCode workspace; see the README.md file for additional steps.

serverside-ad-insertion

Demonstrates use of adverts within streams with Server-Side Ad Insertion.

yospace-controlbar

Demonstrates the integration of the Yospace user interface handling of streams with Server-Side Ad Insertion.

Diagnostics and statistics

event-timeline

Playback of clear HLS streams with feedback and analysis of performance tracking or playback issues.

network-statistics

Demonstrates use of statistics API to get network statistics information.

insight-agent-wrapper

Sends playback metrics and statistics to an Insight analytics server.

Log-Production

Enables logging in production builds.

Advanced features

multi-instance

Provides multiple instances of the player.

smart-lib

Demonstrates use of Broadpeak SmartBeam.

output-device-monitor

Demonstrates use of OTVOutputDeviceMonitor and the monitoring of external connections and disconnections.

Except for objective-c support and yospace-controlbar,  the above example code features are also integrated as part of UnifiedExampleCode using SwiftUI which can run on iOS and tvOS device running version 16 and above.

For full details on integrating the SDK with your application, see the Apple (FPS) SDK 5 Integration Guide. See also the API reference guide provided in the iOS SDK pack.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.