Android SDK (Core)
API Reference

78min
.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.
NwCore Interface Documentation
The NwCore interface is a critical part of the SDK that provides functionalities for audio synchronization, experience playback, and the management of experimental manifest services. It acts as a central point for accessing various services and functionalities required for the interactive and multimedia experiences offered by the SDK.
Properties
appId: String: The unique identifier for the application.
Kotlin
val applicationId = nwCore.appId
val applicationId = nwCore.appId
﻿
environment: NwEnvironment: An instance that defines the operational environment settings.
Kotlin
val envSettings = nwCore.environment // get the environment
nwCore.environment = NwEnvironment.PROD  // set the environment
val envSettings = nwCore.environment // get the environment
nwCore.environment = NwEnvironment.PROD  // set the environment
﻿
locale: String: The current locale of the application, typically used for localization.
Kotlin
val currentLocale = nwCore.locale // get the locale
nwCore.locale = "en"  // set the locale
val currentLocale = nwCore.locale // get the locale
nwCore.locale = "en"  // set the locale
﻿
contentProviderUrl: String: The URL to the content provider that supplies media and experience data.
Kotlin
val providerUrl = nwCore.contentProviderUrl // get the contentProviderUrl
nwCore.contentProviderUrl = <"contentProviderUrl"> // set the contentProviderUrl
val providerUrl = nwCore.contentProviderUrl // get the contentProviderUrl
nwCore.contentProviderUrl = <"contentProviderUrl"> // set the contentProviderUrl
﻿
timelineSync: NwTimelineSync: An instance that handles synchronization with the timeline service.
Kotlin
val timelineSynchronization = nwCore.timelineSync
val timelineSynchronization = nwCore.timelineSync
﻿
isNwSDKInitialized: Boolean: A boolean flag indicating whether the SDK has been initialized.
Kotlin
if (nwCore.isNwSDKInitialized) {
    // SDK has been initialized
}
if (nwCore.isNwSDKInitialized) {
    // SDK has been initialized
}
﻿
Functions
audioSyncService(expManifestId: String, syncContents: SyncContents): AudioSyncService?Initiates an audio synchronization service for a given experience manifest. Returns an instance of AudioSyncService or null if the service cannot be initiated.
Kotlin
val audioSync = nwCore.audioSyncService("expManifestId123", syncContents)
audioSync?.start()
val audioSync = nwCore.audioSyncService("expManifestId123", syncContents)
audioSync?.start()
﻿
experiencePlaybackService(expManifestId: String, audioSyncService: AudioSyncService?): ExperiencePlaybackServiceCreates a playback service for a specific experience manifest, optionally using an audio synchronization service.
Kotlin
val expPlaybackService = nwCore.experiencePlaybackService("expManifestId123", audioSync)

val expPlaybackService = nwCore.experiencePlaybackService("expManifestId123", audioSync)
﻿
ExpComposeView(...)A composable function that renders a UI view for the experience playback service with optional GUI overlay, audio synchronization callback, and various event handlers.
Kotlin
@Composable
fun ExperienceView() {
    nwCore.ExpComposeView(
        context = LocalContext.current,
        expPlaybackService = playbackService,
        guiOverlayUrl = "https://example.com/overlay",
        audioSyncCallback = null,
        exitPlayback = { /* handle exit */ },
        onCheckAudioPermission = { /* check permission */ },
        onCustomAction = { payload -> /* handle custom action */ },
        onError = { exception -> /* handle error */ },
        modifier = Modifier.fillMaxSize()
    )
}

@Composable
fun ExperienceView() {
    nwCore.ExpComposeView(
        context = LocalContext.current,
        expPlaybackService = playbackService,
        guiOverlayUrl = "https://example.com/overlay",
        audioSyncCallback = null,
        exitPlayback = { /* handle exit */ },
        onCheckAudioPermission = { /* check permission */ },
        onCustomAction = { payload -> /* handle custom action */ },
        onError = { exception -> /* handle error */ },
        modifier = Modifier.fillMaxSize()
    )
}
﻿
expView(context: Context, expPlaybackService: ExperiencePlaybackService, guiOverlayUrl: String?, audioSyncCallback: AudioSyncService.AudioSyncCallback? = null, exitPlayback: () -> Unit, onCheckAudioPermission: () -> Unit, onCustomAction: (payload: String?) -> Unit = {}, onError: (exception: NwException?) -> Unit = {}): ViewCreates a traditional Android View for the experience playback service, similar in functionality to ExpComposeView but for use outside of Jetpack Compose.
Kotlin
val view = nwCore.expView(
    context = context,
    expPlaybackService = playbackService,
    guiOverlayUrl = "https://example.com/overlay",
    audioSyncCallback = null,
    exitPlayback = { /* handle exit */ },
    onCheckAudioPermission = { /* check permission */ },
    onCustomAction = { payload -> /* handle custom action */ },
    onError = { exception -> /* handle error */ },
) {
    // Configuration for exitPlayback and other callbacks
}
val view = nwCore.expView(
    context = context,
    expPlaybackService = playbackService,
    guiOverlayUrl = "https://example.com/overlay",
    audioSyncCallback = null,
    exitPlayback = { /* handle exit */ },
    onCheckAudioPermission = { /* check permission */ },
    onCustomAction = { payload -> /* handle custom action */ },
    onError = { exception -> /* handle error */ },
) {
    // Configuration for exitPlayback and other callbacks
}
﻿
checkAudioPermission(isGranted: Boolean)Notifies the SDK of the current audio permission state.
Kotlin
nwCore.checkAudioPermission(isGranted = true)
nwCore.checkAudioPermission(isGranted = true)
﻿
getVersionName(): StringReturns the version name of the SDK.
Kotlin
val versionName = nwCore.getVersionName()
println("SDK Version: $versionName")
val versionName = nwCore.getVersionName()
println("SDK Version: $versionName")
﻿
onDestroy()Cleans up resources and shuts down services when the instance is no longer needed.
Kotlin
nwCore.onDestroy()
nwCore.onDestroy()
﻿
Additional Components
@Composable: Indicates that ExpComposeView is a Jetpack Compose function, allowing it to be used within the Compose UI toolkit.
DevTools: A property that provides access to developer tools for debugging and development purposes.
Exception Handling
NwException: A custom exception type used for error handling within the SDK functions.
Usage Context
This interface is designed to be implemented by the SDK and used by application developers to integrate multimedia and interactive experiences into their applications. It abstracts the complexities involved in synchronizing audio, managing experimental manifests, and handling experience playback.
ExperiencePlaybackService Interface Documentation
The ExperiencePlaybackService interface defines a comprehensive set of functionalities for controlling and managing playback of multimedia experiences, synchronization with audio, and handling of experience manifest data. It offers detailed control over playback and synchronization states, allowing for a robust multimedia experience.
Properties
scope: CoroutineScope
The coroutine scope associated with the playback service for managing asynchronous tasks.
Kotlin
val coroutineScope = experiencePlaybackService.scope
val coroutineScope = experiencePlaybackService.scope
﻿
expManifestId: String
The identifier of the current experience manifest.
Kotlin
val manifestId = experiencePlaybackService.expManifestId
println("Current Experience Manifest ID: $manifestId")
val manifestId = experiencePlaybackService.expManifestId
println("Current Experience Manifest ID: $manifestId")
﻿
isOfflineFileAvailable: Boolean
Indicates whether offline files are available for playback.
Kotlin
if (experiencePlaybackService.isOfflineFileAvailable) {
    println("Offline files are available for playback.")
} else {
    println("No offline files available.")
}
if (experiencePlaybackService.isOfflineFileAvailable) {
    println("Offline files are available for playback.")
} else {
    println("No offline files available.")
}
﻿
isLive: Boolean
Indicates if the current playback is a live experience.
Kotlin
if (experiencePlaybackService.isLive) {
    println("The current playback is a live experience.")
} else {
    println("The current playback is not live.")
}
if (experiencePlaybackService.isLive) {
    println("The current playback is a live experience.")
} else {
    println("The current playback is not live.")
}
﻿
isPlaybackMuted: Boolean
Reflects the current mute state of the playback.
Kotlin
if (experiencePlaybackService.isPlaybackMuted) {
    println("Playback is currently muted.")
} else {
    println("Playback is not muted.")
}
if (experiencePlaybackService.isPlaybackMuted) {
    println("Playback is currently muted.")
} else {
    println("Playback is not muted.")
}
﻿
isPlaying: Boolean
Indicates if playback is currently active.
Kotlin
if (experiencePlaybackService.isPlaying) {
    println("Playback is currently active.")
} else {
    println("Playback is not active.")
}
if (experiencePlaybackService.isPlaying) {
    println("Playback is currently active.")
} else {
    println("Playback is not active.")
}
﻿
isPrepared: Boolean
Shows whether the playback service is prepared to start playback.
Kotlin
if (experiencePlaybackService.isPrepared) {
    println("Playback service is prepared for playback.")
} else {
    println("Playback service is not prepared yet.")
}
if (experiencePlaybackService.isPrepared) {
    println("Playback service is prepared for playback.")
} else {
    println("Playback service is not prepared yet.")
}
﻿
isSynced: Boolean
Indicates whether the playback is synchronized with the audio sync service.
Kotlin
if (experiencePlaybackService.isSynced) {
    println("Playback is synchronized with the audio sync service.")
} else {
    println("Playback is not synchronized.")
}
if (experiencePlaybackService.isSynced) {
    println("Playback is synchronized with the audio sync service.")
} else {
    println("Playback is not synchronized.")
}
﻿
isCurrentlySynced: Boolean
Shows if the playback is currently in sync according to the latest checks.
Kotlin
if (experiencePlaybackService.isCurrentlySynced) {
    println("Playback is currently in sync.")
} else {
    println("Playback is currently out of sync.")
}
if (experiencePlaybackService.isCurrentlySynced) {
    println("Playback is currently in sync.")
} else {
    println("Playback is currently out of sync.")
}
﻿
offlineContent: StateFlow<OfflineContent>
A flow of offline content data for the current experience.
Kotlin
experiencePlaybackService.offlineContent.collect { offlineContent ->
    println("Offline content status: ${offlineContent.status}")
}
experiencePlaybackService.offlineContent.collect { offlineContent ->
    println("Offline content status: ${offlineContent.status}")
}
﻿
audioSyncService: AudioSyncService?
The audio synchronization service, if available.
Kotlin
val audioSync = experiencePlaybackService.audioSyncService
audioSync?.let {
    println("Audio sync service is available.")
}
val audioSync = experiencePlaybackService.audioSyncService
audioSync?.let {
    println("Audio sync service is available.")
}
﻿
mediaPlaybackService: MediaPlaybackService
The service responsible for media playback functionalities.
Kotlin
val mediaService = experiencePlaybackService.mediaPlaybackService
println("Media playback service is ready.")
val mediaService = experiencePlaybackService.mediaPlaybackService
println("Media playback service is ready.")
﻿
activeGlobalAudioTrackId: StateFlow<String>
The ID of the currently active global audio track.
Kotlin
experiencePlaybackService.activeGlobalAudioTrackId.collect { trackId ->
    println("Active global audio track ID: $trackId")
}
experiencePlaybackService.activeGlobalAudioTrackId.collect { trackId ->
    println("Active global audio track ID: $trackId")
}
﻿
activeVideoEntityId: StateFlow<String>
The ID of the currently active video entity.
Kotlin
experiencePlaybackService.activeVideoEntityId.collect { entityId ->
    println("Active video entity ID: $entityId")
}
experiencePlaybackService.activeVideoEntityId.collect { entityId ->
    println("Active video entity ID: $entityId")
}
﻿
Playback Control Functions
startSyncedPlayback()
Starts playback that is synchronized with the audio sync service.
Kotlin
experiencePlaybackService.startSyncedPlayback()
println("Synced playback started.")
experiencePlaybackService.startSyncedPlayback()
println("Synced playback started.")
﻿
startUnsyncedPlayback()
Begins playback without synchronization to the audio sync service.
Kotlin
experiencePlaybackService.startUnsyncedPlayback()
println("Unsynced playback started.")
experiencePlaybackService.startUnsyncedPlayback()
println("Unsynced playback started.")
﻿
resumePlayback()
Resumes playback from the current pause state.
Kotlin
experiencePlaybackService.resumePlayback()
println("Playback resumed.")
experiencePlaybackService.resumePlayback()
println("Playback resumed.")
﻿
pausePlayback()
Pauses the currently playing experience.
Kotlin
experiencePlaybackService.pausePlayback()
println("Playback paused.")
experiencePlaybackService.pausePlayback()
println("Playback paused.")
﻿
stopPlayback()
Stops the current playback entirely.
Kotlin
experiencePlaybackService.stopPlayback()
println("Playback stopped.")
experiencePlaybackService.stopPlayback()
println("Playback stopped.")
﻿
muteOrUnmutePlayback(isMute: Boolean, isManualMute: Boolean = false)
Mutes or unmutes the playback based on the isMute parameter. The isManualMute indicates if the action was triggered manually.
Kotlin
experiencePlaybackService.muteOrUnmutePlayback(isMute = true, isManualMute = true)
println("Playback muted.")
experiencePlaybackService.muteOrUnmutePlayback(isMute = true, isManualMute = true)
println("Playback muted.")
﻿
seekBackOrForward(backOrForward: Double)
Seeks the playback backward or forward by a specified amount of time in seconds.
Kotlin
experiencePlaybackService.seekBackOrForward(10.0) // Forward 10 seconds
println("Playback seeked forward by 10 seconds.")
experiencePlaybackService.seekBackOrForward(10.0) // Forward 10 seconds
println("Playback seeked forward by 10 seconds.")
﻿
jumpTo(seekOffset: Double)
Jumps to a specific time offset in the playback.
Kotlin
experiencePlaybackService.jumpTo(60.0) // Jump to 60 seconds
println("Jumped to 60 seconds in the playback.")
experiencePlaybackService.jumpTo(60.0) // Jump to 60 seconds
println("Jumped to 60 seconds in the playback.")
﻿
switchActiveGlobalAudioTrackByEntityId(entityId: String?)
Switches the active global audio track based on the given entity ID.
Kotlin
experiencePlaybackService.switchActiveGlobalAudioTrackByEntityId("entityId123")
println("Switched to the specified global audio track.")
experiencePlaybackService.switchActiveGlobalAudioTrackByEntityId("entityId123")
println("Switched to the specified global audio track.")
﻿
switchActiveVideoTrackByEntityId(entityId: String?)
Switches the active video track based on the provided entity ID.
Kotlin
experiencePlaybackService.switchActiveVideoTrackByEntityId("entityId456")
println("Switched to the specified video track.")
experiencePlaybackService.switchActiveVideoTrackByEntityId("entityId456")
println("Switched to the specified video track.")
﻿
switchActiveGlobalAudioTrack(trackId: String? = null)
Changes the active global audio track to the one identified by trackId.
Kotlin
experiencePlaybackService.switchActiveGlobalAudioTrack("audioTrackId789")
println("Global audio track switched.")
experiencePlaybackService.switchActiveGlobalAudioTrack("audioTrackId789")
println("Global audio track switched.")
﻿
switchActiveVideoTrack(trackId: String? = null)
Changes the active video track to the one identified by trackId.
Kotlin
experiencePlaybackService.switchActiveVideoTrack("videoTrackId012")
println("Video track switched.")
experiencePlaybackService.switchActiveVideoTrack("videoTrackId012")
println("Video track switched.")
﻿
startSyncValidation()
Initiates validation of the current sync status.
Kotlin
experiencePlaybackService.startSyncValidation()
println("Sync validation started.")
experiencePlaybackService.startSyncValidation()
println("Sync validation started.")
﻿
stopSyncValidation()
Stops the ongoing sync validation process.
Kotlin
experiencePlaybackService.stopSyncValidation()
println("Sync validation stopped.")
experiencePlaybackService.stopSyncValidation()
println("Sync validation stopped.")
﻿
startLivePlayback()
Begins playback of a live experience.
Kotlin
experiencePlaybackService.startLivePlayback()
println("Live playback started.")
experiencePlaybackService.startLivePlayback()
println("Live playback started.")
﻿
seekSyncedPlayback()
Seeks the playback while maintaining synchronization.
Kotlin
experiencePlaybackService.seekSyncedPlayback()
println("Playback seeked with synchronization.")
experiencePlaybackService.seekSyncedPlayback()
println("Playback seeked with synchronization.")
﻿
replayPlayback()
Restarts the current playback from the beginning.
Kotlin
experiencePlaybackService.replayPlayback()
println("Playback replayed from the beginning.")
experiencePlaybackService.replayPlayback()
println("Playback replayed from the beginning.")
﻿
restartPlayback()
Restarts the playback, reinitializing any necessary services.
Kotlin
experiencePlaybackService.restartPlayback()
println("Playback restarted.")
experiencePlaybackService.restartPlayback()
println("Playback restarted.")
﻿
changePlaybackSpeed(speed: Double)
Adjusts the playback speed. A speed value of 1 represents normal speed.
Kotlin
experiencePlaybackService.changePlaybackSpeed(1.5) // 1.5x speed
println("Playback speed set to 1.5x.")
experiencePlaybackService.changePlaybackSpeed(1.5) // 1.5x speed
println("Playback speed set to 1.5x.")
﻿
changeQuality(height: Int)
Changes the playback quality based on the specified height parameter.
Kotlin
experiencePlaybackService.changeQuality(1080)
println("Playback quality changed to 1080p.")
experiencePlaybackService.changeQuality(1080)
println("Playback quality changed to 1080p.")
﻿
Sync Functions
initOrUpdateSyncTimeline(position: Double?, syncStartTimeMs: Long?, resyncThreshold: Double?, isResync: Boolean): Double?
Initializes or updates the synchronization timeline with optional parameters for position, start time, and resynchronization threshold.
Kotlin
val updatedPosition = experiencePlaybackService.initOrUpdateSyncTimeline(
    position = 120.0,
    syncStartTimeMs = System.currentTimeMillis(),
    resyncThreshold = 5.0,
    isResync = true
)
println("Updated sync timeline position: $updatedPosition")
val updatedPosition = experiencePlaybackService.initOrUpdateSyncTimeline(
    position = 120.0,
    syncStartTimeMs = System.currentTimeMillis(),
    resyncThreshold = 5.0,
    isResync = true
)
println("Updated sync timeline position: $updatedPosition")
﻿
isSyncAccessible(): Boolean
Checks if synchronization functionalities are accessible.
Kotlin
val syncAccessible = experiencePlaybackService.isSyncAccessible()
println("Is sync accessible? $syncAccessible")
val syncAccessible = experiencePlaybackService.isSyncAccessible()
println("Is sync accessible? $syncAccessible")
﻿
startSync()
Starts the synchronization process for the current playback.
Kotlin
experiencePlaybackService.startSync()
println("Synchronization started.")
experiencePlaybackService.startSync()
println("Synchronization started.")
﻿
startResync()
Initiates a resynchronization process.
Kotlin
experiencePlaybackService.startResync()
println("Resynchronization process initiated.")
experiencePlaybackService.startResync()
println("Resynchronization process initiated.")
﻿
stopSync()
Stops the current synchronization process.
Kotlin
experiencePlaybackService.stopSync()
println("Synchronization stopped.")
experiencePlaybackService.stopSync()
println("Synchronization stopped.")
﻿
Experience Manifest Handling
getExpManifestService(): ExpManifestService
Retrieves the service for managing experience manifests.
Kotlin
val expManifestService = experiencePlaybackService.getExpManifestService()
val expManifestService = experiencePlaybackService.getExpManifestService()
﻿
getExpManifest(): ExpManifestData
Gets the current experience manifest data.
Kotlin
val expManifestData = experiencePlaybackService.getExpManifest()
println("Experience Manifest ID: ${expManifestData.id}")
val expManifestData = experiencePlaybackService.getExpManifest()
println("Experience Manifest ID: ${expManifestData.id}")
﻿
getExpManifestObserver(): StateFlow<ExpManifestData>
Observes changes to the experience manifest data.
Kotlin
val expManifestObserver = experiencePlaybackService.getExpManifestObserver()
expManifestObserver.collect { manifestData ->
    println("Updated Manifest ID: ${manifestData.id}")
}
val expManifestObserver = experiencePlaybackService.getExpManifestObserver()
expManifestObserver.collect { manifestData ->
    println("Updated Manifest ID: ${manifestData.id}")
}
﻿
isExpManifestEmpty(): StateFlow<Boolean>
Checks if the current experience manifest is empty.
Kotlin
val isManifestEmpty = experiencePlaybackService.isExpManifestEmpty()
isManifestEmpty.collect { isEmpty ->
    if (isEmpty) println("Experience manifest is empty.")
}
val isManifestEmpty = experiencePlaybackService.isExpManifestEmpty()
isManifestEmpty.collect { isEmpty ->
    if (isEmpty) println("Experience manifest is empty.")
}
﻿
getEntities(): StateFlow<List<ExpManifestEntity>>
Retrieves a flow of entities defined in the current experience manifest.
Kotlin
val entitiesFlow = experiencePlaybackService.getEntities()
entitiesFlow.collect { entities ->
    entities.forEach { entity ->
        println("Entity ID: ${entity.id}")
    }
}
val entitiesFlow = experiencePlaybackService.getEntities()
entitiesFlow.collect { entities ->
    entities.forEach { entity ->
        println("Entity ID: ${entity.id}")
    }
}
﻿
getEntity(entityId: String?): ExpManifestEntity?
Gets a specific entity by its ID from the experience manifest.
Kotlin
val specificEntity = experiencePlaybackService.getEntity("entityId123")
println("Specific Entity Name: ${specificEntity?.name}")
val specificEntity = experiencePlaybackService.getEntity("entityId123")
println("Specific Entity Name: ${specificEntity?.name}")
﻿
getVideoTracks(): StateFlow<List<ExpManifestVideoTrack>>
Retrieves a flow of video tracks from the experience manifest.
Kotlin
val videoTracksFlow = experiencePlaybackService.getVideoTracks()
videoTracksFlow.collect { videoTracks ->
    videoTracks.forEach { track ->
        println("Video Track ID: ${track.id}")
    }
}
val videoTracksFlow = experiencePlaybackService.getVideoTracks()
videoTracksFlow.collect { videoTracks ->
    videoTracks.forEach { track ->
        println("Video Track ID: ${track.id}")
    }
}
﻿
getAudioTracks(): StateFlow<List<ExpManifestAudioTrack>>
Retrieves a flow of audio tracks from the experience manifest.
Kotlin
val audioTracksFlow = experiencePlaybackService.getAudioTracks()
audioTracksFlow.collect { audioTracks ->
    audioTracks.forEach { track ->
        println("Audio Track ID: ${track.id}")
    }
}
val audioTracksFlow = experiencePlaybackService.getAudioTracks()
audioTracksFlow.collect { audioTracks ->
    audioTracks.forEach { track ->
        println("Audio Track ID: ${track.id}")
    }
}
﻿
getGlobalAudioTracks(): StateFlow<List<ExpManifestGlobalAudioTrack>>
Retrieves a flow of global audio tracks from the experience manifest.
Kotlin
val globalAudioTracksFlow = experiencePlaybackService.getGlobalAudioTracks()
globalAudioTracksFlow.collect { globalAudioTracks ->
    globalAudioTracks.forEach { track ->
        println("Global Audio Track ID: ${track.id}")
    }
}
val globalAudioTracksFlow = experiencePlaybackService.getGlobalAudioTracks()
globalAudioTracksFlow.collect { globalAudioTracks ->
    globalAudioTracks.forEach { track ->
        println("Global Audio Track ID: ${track.id}")
    }
}
﻿
getAudioTrackById(trackId: String?): ExpManifestAudioTrack?
Gets a specific audio track by its ID from the experience manifest.
Kotlin
val audioTrack = experiencePlaybackService.getAudioTrackById("audioTrackId123")
println("Audio Track Name: ${audioTrack?.name}")
val audioTrack = experiencePlaybackService.getAudioTrackById("audioTrackId123")
println("Audio Track Name: ${audioTrack?.name}")
﻿
getVideoTrackById(trackId: String?): ExpManifestVideoTrack?
Gets a specific video track by its ID from the experience manifest.
Kotlin
val videoTrack = experiencePlaybackService.getVideoTrackById("videoTrackId123")
println("Video Track Name: ${videoTrack?.name}")
val videoTrack = experiencePlaybackService.getVideoTrackById("videoTrackId123")
println("Video Track Name: ${videoTrack?.name}")
﻿
setExpManifestListener(expManifestListener: ExpManifestListener?)
Sets a listener to observe changes in the experience manifest.
Kotlin
experiencePlaybackService.setExpManifestListener(object : ExpManifestListener {
    override fun onManifestUpdated(newManifest: ExpManifestData) {
        println("Manifest has been updated. New ID: ${newManifest.id}")
    }

    // Implement other required methods...
})
experiencePlaybackService.setExpManifestListener(object : ExpManifestListener {
    override fun onManifestUpdated(newManifest: ExpManifestData) {
        println("Manifest has been updated. New ID: ${newManifest.id}")
    }

    // Implement other required methods...
})
﻿
Playback Information Retrieval
getCurrentPlaybackDetails(): CurrentPlaybackDetails
Retrieves details about the current playback state.
Kotlin
val currentPlaybackDetails = experiencePlaybackService.getCurrentPlaybackDetails()
println("Current Playback Position: ${currentPlaybackDetails.position}")
val currentPlaybackDetails = experiencePlaybackService.getCurrentPlaybackDetails()
println("Current Playback Position: ${currentPlaybackDetails.position}")
﻿
getExpInfo(): CurrentPlaybackDetails?
Gets extended information about the current experience.
Kotlin
val expInfo = experiencePlaybackService.getExpInfo()
expInfo?.let {
    println("Experience Duration: ${it.duration}")
}
val expInfo = experiencePlaybackService.getExpInfo()
expInfo?.let {
    println("Experience Duration: ${it.duration}")
}
﻿
getGlobalAudioById(entityId: String?): ExpManifestGlobalAudioTrack?
Retrieves a global audio track by its entity ID from the experience manifest.
Kotlin
val globalAudioTrack = experiencePlaybackService.getGlobalAudioById("audioEntityId123")
globalAudioTrack?.let {
    println("Global Audio Track Name: ${it.name}")
}
val globalAudioTrack = experiencePlaybackService.getGlobalAudioById("audioEntityId123")
globalAudioTrack?.let {
    println("Global Audio Track Name: ${it.name}")
}
﻿
getVideoTrackByEntityId(entityId: String?): ExpManifestVideoTrack?
Retrieves a video track by its entity ID from the experience manifest.
Kotlin
val videoTrack = experiencePlaybackService.getVideoTrackByEntityId("videoEntityId123")
videoTrack?.let {
    println("Video Track Title: ${it.title}")
}
val videoTrack = experiencePlaybackService.getVideoTrackByEntityId("videoEntityId123")
videoTrack?.let {
    println("Video Track Title: ${it.title}")
}
﻿
Listener Management
addExperienceListener(playbackExperienceListener: PlaybackExperienceListener)
Adds a listener for playback experience events.
Kotlin
experiencePlaybackService.addExperienceListener(object : PlaybackExperienceListener {
    override fun onPlaybackStarted() {
        println("Playback has started.")
    }

    override fun onPlaybackPaused() {
        println("Playback has been paused.")
    }

    // Implement other required methods...
})
experiencePlaybackService.addExperienceListener(object : PlaybackExperienceListener {
    override fun onPlaybackStarted() {
        println("Playback has started.")
    }

    override fun onPlaybackPaused() {
        println("Playback has been paused.")
    }

    // Implement other required methods...
})
﻿
addSyncListener(syncListener: SyncListener)
Adds a listener for synchronization events.
Kotlin
experiencePlaybackService.addSyncListener(object : SyncListener {
    override fun onSyncStarted() {
        println("Synchronization has started.")
    }

    override fun onSyncStopped() {
        println("Synchronization has stopped.")
    }

    // Implement other required methods...
})
experiencePlaybackService.addSyncListener(object : SyncListener {
    override fun onSyncStarted() {
        println("Synchronization has started.")
    }

    override fun onSyncStopped() {
        println("Synchronization has stopped.")
    }

    // Implement other required methods...
})
﻿
Service Termination
terminateExpPlaybackService()
Terminates the experience playback service, cleaning up any resources and stopping all ongoing activities.
Ensure you call terminateExpPlaybackService upon exiting your application or when the service is not required to avoid unexpected behavior, crashes, or lag. This step is vital for releasing resources and maintaining your app's stability and performance.
Kotlin
experiencePlaybackService.terminateExpPlaybackService()
println("Experience playback service has been terminated.")
experiencePlaybackService.terminateExpPlaybackService()
println("Experience playback service has been terminated.")
﻿
﻿
This documentation outlines the core functionalities of the ExperiencePlaybackService interface, enabling developers to effectively manage and control multimedia playback experiences within their applications.
Lifecycle Management
﻿
onDestroy(): This function should be called when the UI will close. It is used to release resources and stop any ongoing operations.
Kotlin
override fun onDestroy() {
    super.onDestroy()
    coreSdk.onDestroy()
}
override fun onDestroy() {
    super.onDestroy()
    coreSdk.onDestroy()
}
﻿
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.
The NwExpUI alone does not play any content. It needs to be rendered above a player or a playback system like the NativeWaves Core.
Here's an overview of the NwExpUI interface:

nativeToWebActions: A lazy-initialized instance of NativeToWebActions interface. This instance converts the action type and payload into a JavaScript function call and executes this JavaScript in the WebView. Logging is also done to track the JavaScript function call.
nativeToWeb(actions: NativeToWebActions):  This function takes a NativeToWebActions object as a parameter and sends it to the WebView. If the WebView overlay is initialized, it directly sends the actions to WebView. Otherwise, it adds the actions to a waiting list _waitingListedActions to be sent later.
JSInterfaceActions: A lazy-initialized instance of JSInterfaceActions. This instance provides callbacks for various JavaScript-related operations such as asking for permissions, handling native to web actions, managing core SDK, volume, playback, etc. It also handles operations like GUI readiness, manual mute, and sync status. It also takes care of actions to be taken when the WebView overlay is initialized like sending waiting list actions to WebView and starting the WebView experience.
volumeObserver: A lazily initialized observer that responds to changes in system volume settings, invoking a function to handle volume-related actions and updates in the application.
Guides & Tutorials
Troubleshooting and FAQs