The SDK provides the NwCore singleton class through which you can access all of the SDKs functionalities.
Your app needs the `Privacy - Microphone Usage Description` in the Info.plist for recording audio, if second screen sync should be available.
Initialize SDK
To use the SDK in a class, import the following:
Swift
import NwCoreSdk
import NwCoreSdk
﻿
The first step to initialize the SDK is to call the NwCore singleton.
Swift
let nwCore = NwCore.shared
let nwCore = NwCore.shared
﻿
﻿Start Watching Experience
There are three core plugins that handle playback, sync, and any feature enabled in the overlay. They are as follows:
Swift
// Mandatory properties
let appId: String = "<app-id>"
let expManifestId: String = "<manifest-id>"
// Mandatory properties
let appId: String = "<app-id>"
let expManifestId: String = "<manifest-id>"
﻿
SyncService (optional)
The sync service handles all sync-related tasks. It's an optional plugin that relies on a SMDS endpoint, a channel group and a library. If omitted, no sync functionality will be available in the experience.
Swift
// Sync properties
let smdsEndpoint: URL = URL(string: "<smds-endpoint>")
let channelId: String = "<channel-id">
let libraryId: String = "<library-id">
let audioSyncMode = .CHANNEL // .LIBRARY | .CHANNEL
let syncMode = .SYNC_OPTIONAL // .SYNC_ONLY | .SYNC_OPTIONAL

// Optional sync properties
let directSyncId: String?

// Get a new sync service instance
let syncService: NwAudioSyncService = nwCore.syncService(appId: appId,
                                                         expManifestId: expManifestId,
                                                         syncConfig: syncConfig,
                                                         audioSyncMode: audioSyncMode,
                                                         smdsEndpoint: smdsEndpoint,
                                                         libraryId: libraryId,
                                                         directSyncId: directSyncId,
                                                         channelId: channelId)
// Sync properties
let smdsEndpoint: URL = URL(string: "<smds-endpoint>")
let channelId: String = "<channel-id">
let libraryId: String = "<library-id">
let audioSyncMode = .CHANNEL // .LIBRARY | .CHANNEL
let syncMode = .SYNC_OPTIONAL // .SYNC_ONLY | .SYNC_OPTIONAL

// Optional sync properties
let directSyncId: String?

// Get a new sync service instance
let syncService: NwAudioSyncService = nwCore.syncService(appId: appId,
                                                         expManifestId: expManifestId,
                                                         syncConfig: syncConfig,
                                                         audioSyncMode: audioSyncMode,
                                                         smdsEndpoint: smdsEndpoint,
                                                         libraryId: libraryId,
                                                         directSyncId: directSyncId,
                                                         channelId: channelId)
﻿
ExperiencePlaybackService
The ExperiencePlaybackService is the engine that handles all playback-experience related features. The sync service is an optional injection to the experience playback service.
Swift
let experiencePlaybackService = nwCore.experiencePlaybackService(expManifestId: expManifestId, 
                                                                 syncService: syncService)

let experiencePlaybackService = nwCore.experiencePlaybackService(expManifestId: expManifestId, 
                                                                 syncService: syncService)
﻿
ExperienceViewController
You can call a new view controller for the given experience with above injected options. It takes a guiOverlayUrl as property to load the respective GUI. See Guides & Tutorials﻿ on how to use a custom gui overlay.
Swift
let videoController = nwCore.expViewController(configId: appId,
                                               experiencePlaybackService: experiencePlaybackService,
                                               url: guiOverlayUrl,
                                               onError: onError)
                                               
// Error handling
func onError(_ error: NwError) {
  // ..
}

let videoController = nwCore.expViewController(configId: appId,
                                               experiencePlaybackService: experiencePlaybackService,
                                               url: guiOverlayUrl,
                                               onError: onError)
                                               
// Error handling
func onError(_ error: NwError) {
  // ..
}
﻿
Presenting the view controller on top of the current view stack will open the experience and start the playback. 
Depending on your configuration, an event-specific experience or the default experience will be loaded and the second screen sync option will be available, or not. For more information about the different options, please check the Guides & Tutorials﻿ chapter.
﻿

Installation

Integrate EXP Events

Docs powered by Archbee

TABLE OF CONTENTS

Initialize SDK

Start Watching Experience

SyncService (optional)

ExperiencePlaybackService

ExperienceViewController

Getting Started

Initialize SDK

﻿Start Watching Experience

SyncService (optional)

ExperiencePlaybackService

ExperienceViewController

Start Watching Experience