nexxPLAY for iOS
nexxPLAY for iOS is a native Player, that is inteded to work in native iOS Apps
You can find all necessary Binaries for Download and latest Changelogs always here:
General Integration
In Xcode, select your project, select your target and open the tab “General”
Drag the nexxPlay.framework file from the Finder to the “Embedded Binaries” section
Please make sure that the framework is also included in “Linked Frameworks and Libraries”
Change your tab to “Build Phases”
Drag the nexxPlay.bundle from the Finder to the “Copy Bundle resources”
IMA SDK - 3rd Party Library
nexxPLAY contains presenting Video Ads via the Google IMA SDK. If the Player will use this functionality, an additional SDK need to be added to the project.
The current version of IMA used in nexxPLAY is 3.17.0 and can be downloaded here.
Please drag these frameworks into the "Embedded Binaries" section of your target (exactly as explained for the nexxPLAY framework) and make sure they also appear in the "Linked Frameworks and Libraries" section.
Adding a Player Instance
As soon as the PlayerView is deallocated, the player will automatically stop.
Player Environment
The NexxPLAYEnvironment object contains global settings for the player object. Except for the domain
all the settings are optional and have a predefined value. The settings are:
Attribute | Type | Value |
domain | String | the ID of the domain (mandatory) |
sessionID | String | the ID of the current Session |
language | 2-Letter-Code | the Player Langage, will be computed by the System Language and Domain Settings if omitted |
userHash | String | an Identifer of the currently loggedin User |
externalUserReference | String | an Identifier of a User, that is not registered by nexxOMNIA |
campaign | int | the ID of an existing Campaign of the calling Domain |
affiliatePartner | Int | the ID of an existing Affiliate Partner of the calling Domain |
deliveryPartner | Int | the ID of an existing DeliveryPartner of the calling Domain |
contextReference | String | the Context Reference for this Player (a free String of "where is this Player located" for Reporting) |
platformVariant | String | the PlatformVariant for this Player (usefull Values will be given by 3Q) |
platformVariantIndex | Int | if platformVariant is not empty, this might further specify the current platform Variant. |
appVersion | String | the Version of the App, including the SDK |
useSSL | Bool | set to false if the Player should not use SSL (default is true) |
trackingOptOuted | Bool | if the App user explicitley opts out of Tracking and this Information is relevant for Ads, set this to true |
consentString | String | in TCF/CMP Envrionments, the Player might need the User Consent String for Ad Calls |
alwaysInFullscreen | Bool | initially and always show the Player in Fullscreen (default is false) |
showCloseButtonOnFullscreen | Bool | set to false, if the Fullscreen should not show a "close" Button (default is true) |
googleIMAReferenceViewController | UIViewController | the Google IMA SDK presents the advertisement modally on a UIViewController once the user taps the video ad. If the Google IMA SDK is used but no view controller is set, the advertisement will open in Safari (default is |
hideStatusbarOnFullscreen | Bool | if set to true, the status bar is automatically hidden when the player is in fullscreen mode (default is |
openPodcastURLsDirectly | Bool | if set to true, podcast URLs will automatically be opened by the default browser application (default is |
Player Configuration
Just like the Javascript Player, the Player can be configured by a Configuration Object. This Object will be used in one of the various play() Methods of the SDK.
All Options are identical to the general SDK Override Options, you will find here:
SDK Override OptionsPlease notice, that some Options only make sense in the Web and are therefore not supported.
If you are looking for the TCF Consent String Management, this is documented here:
GDPR and TCF 2.0Public Methods
Preparing and Configuring the Player
Playback Control
Requesting Player Status and Details
LocalMedia and Offline Playback
nexxPLAY for iOS also supports playback of previously downloaded media items and therefore offers some SDK methods to manage localMedia.
This Feature must be enabled within nexxOMNIA. Furthermore, various Settings to finetune the Details of the localMedia Behaviour can be setup there. Contact 3Q for more Information.
Player Notifications
Just like the JavaScript Player, the Player emits all Events to a Listener Function.
The notifications are sent by the NSNotificationCenter. To receive a notification you can use the following code snippet:
The appropriate function that is called when the notification is received:
If you have multiple players you can determine the player that sent the notification by checking notification.object
If you want to receive all notifications from the player, there is a convenience function:
Whenever a notification from playerView is received by the observer, the functionnotificationReceived
is called. With notification.name
you can determine which notification was received and act accordingly.
There is also a convenience function to remove the observer for all notifications:
You can find a List of all Player Notifications here:
Player EventsPlease notice, that on iOS, the Events (Notifications) have a different name, that is built by the following Rule: "nexxPlay" + EventName.camelCase() + "Notification".
So for example, a "pause" Notification will become a "nexxPlayPauseNotification", and a "changeplaypos" Notification will become a "nexxPlayChangePlayPosNotification"
Additional Information
Fullscreen Behaviour
When the player switches to fullscreen, a subview (containing the video and all controls) of the PlayerView is added to the applications key window UIApplication.sharedApplication().keyWindow
. Once the user switches back, the subview is added back to the PlayerView.
Orientation Behaviour
When the device is rotated, the video automatically rotates accordingly.
AirPlay and Picture-in-Picture Support
The player does support AirPlay and PiP, if it is also supported by the device.
Furthermore the Background Modes capability Audio, Airplay and Picture in Picture must be activated in your project settings in Xcode.
Picture-in-Picture AND AirPlay also requirs to be enabled in nexxOMNIA Player Settings and/or Configuration with Overrides.
Additionally, it may not be available on all Devices, depending on Hardware Capabilities.
Widgets
The iOS Platform also supports native Widgets by nexxPLAY.
Widgets for native AppsLast updated