iOS SDK (Core)
API Reference

26min
Please find below an overview of the available APIs for you to use. Also check out the Guides & Tutorials﻿ chapter for useful information about using the SDK.
ExperiencePlaybackService
ExperiencePlaybackService is the fundamental component within the SDK, serving as the main hub for all interactions between your application and the SDK. Think of it as the command center or the control room—it manages how the app communicates with the SDK, making sure they understand each other and work together seamlessly. Here's an overview of the interface:
EXP Manifest
Retrieving the information of the current EXP manifest:
Swift
experiencePlaybackService.expManifest -> NwExpManifest?
experiencePlaybackService.expManifest -> NwExpManifest?
﻿
Playback
The SDK provides certain methods to control a playback.
Initialize Playback
Initializing the playback will set the playback view and sets a PlaybackDelegate.
Swift
experiencePlaybackService.initializePlayback(playbackView: UIView, delegate: NwPlaybackDelegate?)
experiencePlaybackService.initializePlayback(playbackView: UIView, delegate: NwPlaybackDelegate?)
﻿
Playback Delegate
Setting a PlaybackDelegate will trigger the respective callback methods.
Swift
protocol NwExperiencePlaybackServiceDelegate {
   // Called when playback has started
   func onPlaybackStarted(contentType: NwContentType, isPlaying: Bool)
   // Called when playback seek has completed
   func onPlaybackSeekCompleted(position: Double)
   // Called when playback has paused
   func onPlaybackPaused()
   // Called when playback has stopped
   func onPlaybackStopped()
   // Called during playback to report playback progress
   func onPlaybackProgress(position: Double, duration: Double, hasEnded: Bool, hasVideoContent: Bool, isLive: Bool, isSync: Bool?)
   // Called when an error occured
   func onError(_ error : NwError)
   // Called on mute toggle
   func onMute(_ mute: Bool)
   // Called on systevolume change
   func onVolumeChange(_ volume: Double)
} 
protocol NwExperiencePlaybackServiceDelegate {
   // Called when playback has started
   func onPlaybackStarted(contentType: NwContentType, isPlaying: Bool)
   // Called when playback seek has completed
   func onPlaybackSeekCompleted(position: Double)
   // Called when playback has paused
   func onPlaybackPaused()
   // Called when playback has stopped
   func onPlaybackStopped()
   // Called during playback to report playback progress
   func onPlaybackProgress(position: Double, duration: Double, hasEnded: Bool, hasVideoContent: Bool, isLive: Bool, isSync: Bool?)
   // Called when an error occured
   func onError(_ error : NwError)
   // Called on mute toggle
   func onMute(_ mute: Bool)
   // Called on systevolume change
   func onVolumeChange(_ volume: Double)
} 
﻿
Playback Controls
Start Playback
If the current program is a live event, the playback will automatically start at the live edge. If it is a VOD playback, the playback will start from the beginning:
Swift
// Start playback at the most relevant position:
experiencePlaybackService.startPlayback()

// Start a synced playback will trigger an initial sync:
experiencePlaybackService.startSyncedPlayback()
// Start playback at the most relevant position:
experiencePlaybackService.startPlayback()

// Start a synced playback will trigger an initial sync:
experiencePlaybackService.startSyncedPlayback()
﻿
Pause Playback
Swift
experiencePlaybackService.pausePlayback()
experiencePlaybackService.pausePlayback()
﻿
Resume Playback
Swift
experiencePlaybackService.resumePlayback()
experiencePlaybackService.resumePlayback()
﻿
Stop Playback
Swift
experiencePlaybackService.stopPlayback()
experiencePlaybackService.stopPlayback()
﻿
Mute/Unmute Audio
Swift
let shouldMute: Bool = <true|false>
experiencePlaybackService.muteAudio(shouldMute)
let shouldMute: Bool = <true|false>
experiencePlaybackService.muteAudio(shouldMute)
﻿
Seek to a position
Swift
let endPosition: Double = <position>
experiencePlaybackService.seek(to: endPosition)
let endPosition: Double = <position>
experiencePlaybackService.seek(to: endPosition)
﻿
Jump backward/forward
Swift
let jumpValue: Double = <value>
experiencePlaybackService.jump(by: jumpValue)
let jumpValue: Double = <value>
experiencePlaybackService.jump(by: jumpValue)
﻿
Content
Get available Entities
Swift
// Get available video entities
experiencePlaybackService.getVideoEntities() -> [NwEntity]?

// Get available audio entities
experiencePlaybackService.getAudioEntities() -> [NwEntity]?
// Get available video entities
experiencePlaybackService.getVideoEntities() -> [NwEntity]?

// Get available audio entities
experiencePlaybackService.getAudioEntities() -> [NwEntity]?
﻿
Get selected Entity
Swift
// Get current selected video entityId
experiencePlaybackService.getSelectedVideoEntityId() -> String?

// Get current selected audio entityId
experiencePlaybackService.getSelectedAudioEntityId() -> String?
// Get current selected video entityId
experiencePlaybackService.getSelectedVideoEntityId() -> String?

// Get current selected audio entityId
experiencePlaybackService.getSelectedAudioEntityId() -> String?
﻿
Set Entity
Swift
// Set video entity
experiencePlaybackService.setSelectedVideoEntity(entityId: String?)

// Set audio entity
experiencePlaybackService.setSelectedAudioEntity(entityId: String?)
// Set video entity
experiencePlaybackService.setSelectedVideoEntity(entityId: String?)

// Set audio entity
experiencePlaybackService.setSelectedAudioEntity(entityId: String?)
﻿
Second-Screen Sync
If the second-screen sync is set-up and configured for your company, it is easy to enable it in the SDK.
Enable Sync
The second-screen sync can be enabled using the SyncConfig. The SyncConfig offers three options:
SYNC_ONLY a sync against a main screen is required for playback
SYNC_OPTIONAL the sync is optional and if sync information is available, the user can choose to sync to a main screen
SYNC_NO the sync is disabled
To set the SyncConfig just do the following:
Swift
let syncConfig = <.SYNC_ONLY|.SYNC_OPTIONAL|.NO_SYNC>
nwCore.syncService(..., syncConfig: syncConfig, ...)
let syncConfig = <.SYNC_ONLY|.SYNC_OPTIONAL|.NO_SYNC>
nwCore.syncService(..., syncConfig: syncConfig, ...)
﻿
AudioSyncMode
There are two modes the second-screen sync can be used:
channelSync to sync against a live channel, e.g. a TV channel
directSync to sync against a VOD event
ChannelSync
The AudioSyncMode is set to AudioSyncMode.CHANNEL by default.
To set the AudioSyncMode just call:
Swift
nwCore.syncService(..., audioSyncMode: .CHANNEL, ...)
nwCore.syncService(..., audioSyncMode: .CHANNEL, ...)
﻿
All settings for the ChannelSync are configured via the AppConfig in the Console. There the endpoint as well as the channel information required for syncing is set.
In case you want to overwrite the backend setting, you can manually set a channelId:
Swift
let channelId: String = "<channel-id>"
nwCore.syncService(..., channelId: channelId, ...)
let channelId: String = "<channel-id>"
nwCore.syncService(..., channelId: channelId, ...)
﻿
DirectSync
To enable the direct sync to e.g. sync against a VOD event, you need to set the AudioSyncMode to AudioSyncMode.LIBRARY:
Swift
nwCore.syncService(..., audioSyncMode: .LIBRARY, ...)
nwCore.syncService(..., audioSyncMode: .LIBRARY, ...)
﻿
Additionally, you need to set a directSyncId, so the correct sync query is used:
Swift
let directSyncId: String = "<directSyncId>"
nwCore.syncService(..., directSyncId: directSyncId, ...)
let directSyncId: String = "<directSyncId>"
nwCore.syncService(..., directSyncId: directSyncId, ...)
﻿
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.
Custom SMDS Endpoint
Setting a custom SMDS endpoint will direct the audio parts to be checked for a sync to the given service. 
Swift
let smdsEndpoint = URL(string: "<url>")
nwCore.syncService(..., smdsEndpoint: smdsEndpoint, ...)
let smdsEndpoint = URL(string: "<url>")
nwCore.syncService(..., smdsEndpoint: smdsEndpoint, ...)
﻿
Initialize Sync
Initializing the sync will set up all necessary dependencies for operational mode and sets a SyncDelegate.
Swift
experiencePlaybackService.initializeSync(syncDelegate: NwSyncDelegate)
experiencePlaybackService.initializeSync(syncDelegate: NwSyncDelegate)
﻿
Sync Delegate
Setting a SyncDelegate will trigger the respective callback methods.
Swift
protocol NwAudioSyncServiceDelegate {
  // Called when sync was started.
  func synchronizationOffsetFound(correlation: MediaAudioQueryMatch, syncStartTime: Double, isResync: Bool)
  // Called when an error occured during sync.
  func synchronizationError(_ error: NwError)
}
protocol NwAudioSyncServiceDelegate {
  // Called when sync was started.
  func synchronizationOffsetFound(correlation: MediaAudioQueryMatch, syncStartTime: Double, isResync: Bool)
  // Called when an error occured during sync.
  func synchronizationError(_ error: NwError)
}
﻿
Sync Controls
To programmatically start, stop or cancel a sync, the interface provides the following methods:
Swift
// Start a sync
experiencePlaybackService.startSync()

// Cancel a running sync
experiencePlaybackService.cancelSync()

// Stop a synchronized experience
experiencePlaybackService.stopSync()
// Start a sync
experiencePlaybackService.startSync()

// Cancel a running sync
experiencePlaybackService.cancelSync()

// Stop a synchronized experience
experiencePlaybackService.stopSync()
﻿
Check current sync state
To check the current playback sync state:
Swift
// Check if plaback is currently running in a synced state
experiencePlaybackService.isSynced() -> Bool

// Check if a running sync is currently in progress
experiencePlaybackService.isSyncing() -> Bool

// Check if current sync state is after a resync has been done
experiencePlaybackService.isResync() -> Bool
// Check if plaback is currently running in a synced state
experiencePlaybackService.isSynced() -> Bool

// Check if a running sync is currently in progress
experiencePlaybackService.isSyncing() -> Bool

// Check if current sync state is after a resync has been done
experiencePlaybackService.isResync() -> Bool
﻿
Dismiss Experience
Stopping the whole experience resets everything. If a new EXP program needs to be started, the old experience should be stopped before in order to avoid any misfunction. If the close button within a PlaybackViewController was tapped, this method is being called automatically and does not need to be triggered separately.
Swift
experiencePlaybackService.stop()
experiencePlaybackService.stop()
﻿
﻿NwExpUI﻿
NwExpUI serves as a customizable interface to GUI Overlays. The communication with the web layer is done using methods to send and receive certain events and states. The class described in the section below wraps this functionality. 
If you want to know more about the underlying system and the event system that is used to communicate between the native and web layer, you can find a more thorough explanation in the Event System﻿ chapter of the Web SDK.
Initialize EXP
See Getting Started﻿ on how to setup and start a full experience.
Guides & Tutorials
Troubleshooting and FAQs
API Reference

ExperiencePlaybackService

EXP Manifest

Playback

Initialize Playback

Playback Delegate

Playback Controls

Content

Get available Entities

Get selected Entity

Set Entity

Second-Screen Sync

Enable Sync

AudioSyncMode

ChannelSync

DirectSync

Custom SMDS Endpoint

Initialize Sync

Sync Delegate

Sync Controls

Check current sync state

Dismiss Experience

﻿NwExpUI﻿

Initialize EXP

NwExpUI
