LwayveSDK Class Reference


                    
                    
                    configuration

Undocumented

Declaration

Swift

public private(set) var configuration: LwayveSDKConfiguration?


                    
                    
                    initialize(configuration:)

This method must be called before the SDK can be used.

Seealso

LwayveSDKDelegate.lwayveSDK(didInit:)

Seealso

LwayveSDKInitializationError

Declaration

Swift

public func initialize(configuration: LwayveSDKConfiguration) throws

Parameters


                                configuration

Configuration object with required parameters

deinitialize()
The SDK will be deinitialized after calling this method.

Note
Deinitialization may be asynchronious. Wait for LwayveSDKDelegate.lwayveSDK(didDeinit:) to be called before initializing the SDK again.
Declaration
Swift

public func deinitialize()
sharedSDK
The singleton object of LwayveSDK
Declaration
Swift

public static let sharedSDK: LwayveSDK


                    
                    
                    add(playlistEventsListener:)

Adds the listener for the playlist events

Declaration

Swift

@objc(addPlaylistEventsListener:)
public func add(playlistEventsListener: PlayListEventsListener)


                    
                    
                    remove(playlistEventsListener:)

Removes the listener for the playlist events

Declaration

Swift

@objc(removePlaylistEventsListener:)
public func remove(playlistEventsListener: PlayListEventsListener)


                    
                    
                    add(delegate:)

Add delegate

Declaration

Swift

@objc(addDelegate:)
public func add(delegate: LwayveSDKDelegate)

Parameters


                                delegate

Receiver of lwayve states notifications


                    
                    
                    remove(delegate:)

Remove delegate

Declaration

Swift

@objc(removeDelegate:)
public func remove(delegate: LwayveSDKDelegate)

Parameters


                                delegate

Receiver of lwayve states notifications


                    
                    
                    setLogLevel(_:components:)

Set logger for specific level and component.

Declaration

Swift

public func setLogLevel(_ level: LwayveSDKLogLevel, components: [LwayveSDKLogComponent])

Parameters

`level`	The log level.
`components`	The list of log components.

language
Using this property you can get or update the SDK preferred language. Update is an asynchronous operation. The default value is the current device language, if the LWAYVE SDK supports it. If a language is not set on the current device, the default is LwayveLanguage.english.
Declaration
Swift

public var language: LwayveLanguage { get set }


                    
                    
                    add(audioControlDelegate:)

Adds a listener for audio playback events.

Declaration

Swift

@objc(addAudioControlDelegate:)
public func add(audioControlDelegate delegate: AudioControlDelegate)

Parameters


                                delegate

An object conforming to the AudioControlDelegate protocol.


                    
                    
                    remove(audioControlDelegate:)

Removes a listener for audio playback events.

Declaration

Swift

@objc(removeAudioControlDelegate:)
public func remove(audioControlDelegate delegate: AudioControlDelegate)

Parameters


                                delegate

An object conforming to the AudioControlDelegate protocol.


                    
                    
                    initializeWithProxSee(configuration:)

Intitializes Lwayve with ProxSee integration. This method must be called before the SDK can be used.

Seealso

LwayveSDKDelegate.lwayveSDK(didInit:)

Seealso

LwayveSDKInitializationError

Declaration

Swift

public func initializeWithProxSee(configuration: LwayveSDKConfiguration) throws

Parameters


                                configuration

Configuration object with required parameters


                    
                    
                    addProxSeeMetadata(metadata:completion:)

Undocumented

Declaration

Swift

public final func addProxSeeMetadata(metadata: [String : String], completion: ((Bool, Error?) -> Void)?)


                    
                    
                    lwayveSDK(didInit:)

Declaration

Swift

public func lwayveSDK(didInit sdk: LwayveSDK)


                    
                    
                    lwayveSDK(didDeinit:)

Declaration

Swift

public func lwayveSDK(didDeinit sdk: LwayveSDK)


                    
                    
                    didChangeTagsSet(_:)

Undocumented

Declaration

Swift

public func didChangeTagsSet(_ tags: LXTagsProxyProtocol)

isReadyToPlay
See AudioPlaybackControlProtocol.isReadyToPlay
Declaration
Swift

public var isReadyToPlay: Bool { get }
canSkip
See AudioPlaybackControlProtocol.canSkip
Declaration
Swift

public var canSkip: Bool { get }
canRewind
See AudioPlaybackControlProtocol.canRewind
Declaration
Swift

public var canRewind: Bool { get }
isPlaying
See AudioPlaybackControlProtocol.isPlaying
Declaration
Swift

public var isPlaying: Bool { get }


                    
                    
                    isWaitingForCurrentTrackToBeLoaded

Declaration

Swift

public var isWaitingForCurrentTrackToBeLoaded: Bool { get }

play()
See AudioPlaybackControlProtocol.play()
Declaration
Swift

public func play()
pause()
See AudioPlaybackControlProtocol.pause()
Declaration
Swift

public func pause()
stop()
See AudioPlaybackControlProtocol.stop()
Declaration
Swift

public func stop()
skip()
See AudioPlaybackControlProtocol.skip()
Declaration
Swift

public func skip()
rewind()
See AudioPlaybackControlProtocol.rewind()
Declaration
Swift

public func rewind()

playlist
See PlayListEventsListener.playlist
Declaration
Swift

public var playlist: Playlist? { get }
refreshPlaylist()
See PlaylistControlProtocol.refreshPlaylist()
Declaration
Swift

public func refreshPlaylist()
forceReloadExperience()
See PlaylistControlProtocol.forceReloadExperience()
Declaration
Swift

public func forceReloadExperience()
generatedPlaylist
See PlaylistControlProtocol.generatedPlaylist
Declaration
Swift

public var generatedPlaylist: Playlist? { get }
audioQueue
See PlaylistControlProtocol.audioQueue
Declaration
Swift

public var audioQueue: [AudioTrack] { get }
unplayedTracksQueue
See PlaylistControlProtocol.unplayedTracksQueue
Declaration
Swift

public var unplayedTracksQueue: [AudioTrack] { get }
playedTracksHistory
See PlaylistControlProtocol.playedTracksHistory
Declaration
Swift

public var playedTracksHistory: [AudioTrack] { get }
playedTracksIds
See PlaylistControlProtocol.playedTracksIds
Declaration
Swift

public var playedTracksIds: Set<String> { get }
clearPlayedItems()
See PlaylistControlProtocol.clearPlayedItems()
Declaration
Swift

public func clearPlayedItems()
contentUpdateInfo
See PlaylistControlProtocol.var contentUpdateInfo: ContentUpdateType
Declaration
Swift

public var contentUpdateInfo: ContentUpdateInfo { get }

notificationsActive
See ApplicationRemoteNotificationsHandler.notificationsActive
Declaration
Swift

public var notificationsActive: Bool { get set }
handleApplication(_:didFinishLaunchingWithOptions:)
See ApplicationRemoteNotificationsHandler.handleApplication(_:didFinishLaunchingWithOptions:)
Declaration
Swift

public func handleApplication(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey : Any]?)
handleApplication(_:didReceiveRemoteNotification:fetchCompletionHandler:)
See ApplicationRemoteNotificationsHandler.handleApplication(_:didReceiveRemoteNotification:fetchCompletionHandler:)
Declaration
Swift

public func handleApplication(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable: Any], fetchCompletionHandler: @escaping (UIBackgroundFetchResult) -> Void)


                    
                    
                    handleApplication(_:didRegisterForRemoteNotificationsWithDeviceToken:)

Declaration

Swift

public func handleApplication(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data)

defaultAlbumArtworkImage
See LwayveNowPlayingInfoProtocol.defaultAlbumArtworkImage
Declaration
Swift

public var defaultAlbumArtworkImage: UIImage? { get set }

sendAnalyticEvents()
Declaration
Swift

public func sendAnalyticEvents()


                    
                    
                    getAnalyticsDeviceId(_:)

Declaration

Swift

public func getAnalyticsDeviceId(_ completion: @escaping (_ deviceId: String) -> Void)


                    
                    
                    audioBufferMaxTrackCount

Declaration

Swift

public var audioBufferMaxTrackCount: Int { get set }


                    
                    
                    audioBufferMaxSize

Undocumented

Declaration

Swift

public var audioBufferMaxSize: Int { get set }


                    
                    
                    audioCacheMaxSize

Undocumented

Declaration

Swift

public var audioCacheMaxSize: Int { get set }

clearAudioCache()
Declaration
Swift

public func clearAudioCache()


                    
                    
                    loadActions(_:completion:)

See ClipActionsProtocol.loadActions(actions:completion:)

Declaration

Swift

public func loadActions(_ actions: ClipActions, completion: @escaping (_ actions: [ClipAction]) -> Void)

performClipAction(_:completion:)
See ClipActionsProtocol.performClipAction(_:completion:)
Declaration
Swift

public func performClipAction(_ actionInfo: ClipAction, completion: @escaping () -> Void)

set(locations:)
See ContextControlProtocol.set(locations:)
Declaration
Swift

public func set(locations: [String])
set(userLikes:)
See ContextControlProtocol.set(userLikes:)
Declaration
Swift

public func set(userLikes: [String])
currentUserContext
See ContextControlProtocol.currentUserContext
Declaration
Swift

public var currentUserContext: UserContext? { get }
add(userLikes:)
See ContextControlProtocol.add(userLikes:)
Declaration
Swift

public func add(userLikes: [String])
add(locations:)
See ContextControlProtocol.add(locations:)
Declaration
Swift

public func add(locations: [String])
remove(userLikes:)
See ContextControlProtocol.remove(userLikes:)
Declaration
Swift

public func remove(userLikes: [String])
remove(locations:)
See ContextControlProtocol.remove(locations:)
Declaration
Swift

public func remove(locations: [String])


                    
                    
                    timeOffset

Declaration

Swift

public var timeOffset: TimeInterval { get set }


                    
                    
                    exclusiveTag

Declaration

Swift

public var exclusiveTag: String? { get set }

allExperienceTags
See ExperienceSupplementaryInfo.allExperienceTags
Declaration
Swift

public var allExperienceTags: [String] { get }
allExperienceLocations
See ExperienceSupplementaryInfo.allExperienceLocations
Declaration
Swift

public var allExperienceLocations: [String] { get }
rawExperience
Declaration
Swift

public var rawExperience: Data? { get }

overrideImage(_:forActionType:)
See OuterBandAppearanceProtocol.overrideImage(_:forActionType:)
Declaration
Swift

public func overrideImage(_ image: UIImage?, forActionType actionType: String)
overrideTitle(_:forActionType:)
See OuterBandAppearanceProtocol.overrideTitle(_:forActionType:)
Declaration
Swift

public func overrideTitle(_ title: String?, forActionType actionType: String)


                    
                    
                    getProxSeeConfigurationKey(_:)

Declaration

Swift

public func getProxSeeConfigurationKey(_ completion: @escaping (String?) -> Void) -> AsyncTaskCancelBlock

uploadUserRecordedAudio(fileURL:completion:)
See UserRecordedAudioUploadProtocol.uploadUserRecordedAudio(fileURL:completion:)
Declaration
Swift

public func uploadUserRecordedAudio(fileURL: URL, completion: @escaping (_ error: Error?) -> Void)
maximumUserRecordedAudioDuration
See UserRecordedAudioUploadProtocol.maximumUserRecordedAudioDuration
Declaration
Swift

public var maximumUserRecordedAudioDuration: UserRecordedAudioDuration { get set }