iOS SDK (Core)
Guides & Tutorials

14min
The Guides & Tutorials section offers step-by-step instructions and practical examples for using the iOS SDK. 
Custom Overlay GUI
The UI layer of a NativeWaves experience on Android and iOS is a web-based layer that changes dynamically, based on the configuration done in the NativeWaves Console and the type of event you are watching.
By default, the URL for the web layer is set by the app. You can set your own URL when initializing a new ExperienceViewController.
The communication with the web layer is done using a NwExp interface which calls and receives certain events. The interface is being described in the API Reference﻿.
﻿
Playback & Entity Management
This section will give an quick overview on how to control playback and handle entity (camera) changes.
Accessing playback data
The playback data can be accessed via the NwPlaybackDelegate. This example shows how to access the position of the playback by listening to the callback function.
In addition to just the position, this callback also contains information about duration, if the playback has ended, if the playback has video content available, if the playback is playing at the live-edge and if the playback is playing at the synced position.
Swift
protocol NwPlaybackDelegate {
   ...
   
   // Called during playback to report playback progress
   func onPlaybackProgress(position: Double, duration: Double, hasEnded: Bool, hasVideoContent: Bool, isLive: Bool, isSync: Bool?)
   
   ...
} 
protocol NwPlaybackDelegate {
   ...
   
   // Called during playback to report playback progress
   func onPlaybackProgress(position: Double, duration: Double, hasEnded: Bool, hasVideoContent: Bool, isLive: Bool, isSync: Bool?)
   
   ...
} 
﻿
Triggering an entity (camera) change
The NwCore also provides a simple option to change the currently playing entity (camera).
Swift
// Set video entity
experiencePlaybackService.setSelectedVideoEntity(entityId: String?)
// Set video entity
experiencePlaybackService.setSelectedVideoEntity(entityId: String?)
﻿
If you want to retrieve available entities first to provide the user a selection option, you can get them like this:
Swift
// Get available video entities
experiencePlaybackService.getVideoEntities() -> [NwEntity]?
// Get available video entities
experiencePlaybackService.getVideoEntities() -> [NwEntity]?
﻿
To get the current selected entity, this can be done like this:
Swift
// Get current selected video entityId
experiencePlaybackService.getSelectedVideoEntityId() -> String?
// Get current selected video entityId
experiencePlaybackService.getSelectedVideoEntityId() -> String?
﻿
Getting Started with Second-Screen Sync
To get started with the second-screen sync, the recommended option is to use the directSync mode and try it with some VOD content.
To enable the direct sync to e.g. sync against a VOD event, you need to set the AudioSyncMode to AudioSyncMode.LIBRARY:
Swift
let syncService = nwCore.syncService(..., audioSyncMode: .LIBRARY, ...)
let syncService = nwCore.syncService(..., audioSyncMode: .LIBRARY, ...)
﻿
Additionally, you need to set a directSyncId, so the correct sync query is used:
Swift
let syncService = nwCore.syncService(..., directSyncId: "<direct-sync-id>", ...)
let syncService = nwCore.syncService(..., directSyncId: "<direct-sync-id>", ...)
﻿
The directSyncId is created when sync information is extracted for VOD events. A common setup is to send the directSyncId as part of event information like the programId.
The next step is to initialize the sync and passing your optional delegate if you want to rececive sync callbacks:
Swift
syncService.delegate = self
syncService.delegate = self
﻿
After everything is initialized and ready to go, simply start the sync by calling:
Swift
// Start a sync
experiencePlaybackService.startSync()
// Start a sync
experiencePlaybackService.startSync()
﻿
You can get the sync result by listening to the synchronizationOffsetFound callback, which contains the new offset identified by the sync:
Swift
// Called when an offset was found.
func synchronizationOffsetFound(correlation: MediaAudioQueryMatch, syncStartTime: Double, isResync: Bool)

// Called on error
func synchronizationError(_ error: NwError)
// Called when an offset was found.
func synchronizationOffsetFound(correlation: MediaAudioQueryMatch, syncStartTime: Double, isResync: Bool)

// Called on error
func synchronizationError(_ error: NwError)
﻿
Custom player integration
If you want to implement an individual player logic, you can replace our preshipped player with your own. To do so, you first need to add the customPlayerDelegate to the ExperiencePlaybackService:
Swift
// let experiencePlaybackService = NwCore.shared.expViewController(...)
experiencePlaybackService.customPlayerDelegate = self
// let experiencePlaybackService = NwCore.shared.expViewController(...)
experiencePlaybackService.customPlayerDelegate = self
﻿
You need to implement the NwCustomPlayerDelegate protocol to inject your player whenever it's requested by the ExperiencePlaybackService.
The custom player needs to implement the NwPlayer protocol in order to be compatible with our core engine.
Swift
  func experiencePlaybackService(_ experiencePlaybackService: NwExperiencePlaybackService,
                                 customPlayerFor playbackObject: NwPlaybackObject) -> NwPlayer? {
      return CustomPlayer(playbackObject: playbackObject)
  }
  func experiencePlaybackService(_ experiencePlaybackService: NwExperiencePlaybackService,
                                 customPlayerFor playbackObject: NwPlaybackObject) -> NwPlayer? {
      return CustomPlayer(playbackObject: playbackObject)
  }
﻿
Using a custom CDN
If you want to use a particular CDN, the manifest needs to be configured properly right ahead. That being given, you need to set a expConfigBaseUrl which will be used to fetch the actual CDN config:
Swift
NwCore.shared.expConfigBaseUrl = URL(string: "https://<config>.cdn.nativewaves.com/exp")!
NwCore.shared.expConfigBaseUrl = URL(string: "https://<config>.cdn.nativewaves.com/exp")!
﻿
DRM Handling
If you need to implement DRM handling, there are two ways to exchange credentials. Both ways presume that you implement the NwCustomPlayerDelegate and handle the async exchange function:
Swift
func experiencePlaybackService(_ experiencePlaybackService: any NwExperiencePlaybackService, drmCredentialsFor drmInfo: NwDrmInfo) async -> NwDrmCredentials? {
  // 1. read drm key ids and provider ids from drmInfo
  // 2. select which key pair should be used
  // 3. retrieve license info from your license server and return NwDrmCredentials
}
func experiencePlaybackService(_ experiencePlaybackService: any NwExperiencePlaybackService, drmCredentialsFor drmInfo: NwDrmInfo) async -> NwDrmCredentials? {
  // 1. read drm key ids and provider ids from drmInfo
  // 2. select which key pair should be used
  // 3. retrieve license info from your license server and return NwDrmCredentials
}
﻿
NwDrmCredentials
Swift
struct NwDrmCredentials: {
    var certificateUrl: URL
    var licenseUrl: URL
}
struct NwDrmCredentials: {
    var certificateUrl: URL
    var licenseUrl: URL
}
﻿
Option 1: With our preshipped player, you still need to implement the customPlayerFor method, but just return nil for the custom player.
Swift
 func experiencePlaybackService(_ experiencePlaybackService: NwExperiencePlaybackService,
                                 customPlayerFor playbackObject: NwPlaybackObject) -> NwPlayer? {
    return nil
}
 func experiencePlaybackService(_ experiencePlaybackService: NwExperiencePlaybackService,
                                 customPlayerFor playbackObject: NwPlaybackObject) -> NwPlayer? {
    return nil
}
﻿
Option 2: With your custom player used, everything stays the same as described in Custom player integration.
Integrate EXP Events
API Reference