API Reference

final public class StreamLayer: NSObject

public class func initSDK(
    with key: String,
    isDebug: Bool = false,
    delegate: StreamLayerDelegate? = nil,
    loggerDelegate: SLROverlayLoggerDelegate? = nil
)

StreamLayer.initSDK(with: "YOUR_SDK_KEY", isDebug: true, delegate: self)

@objc
public class func isInitialized() -> Bool

public class func sdkVersion() -> String

public static func configureAPIURL(apiURLString: String?)

@discardableResult
public class func createSession(
    for eventId: String,
    timecodeProvider: SLRTimecodeProvider? = nil,
    andAddMenuItems customMenuItems: [SLRCustomMenuProtocol]? = nil
) -> SLREventSession

let session = StreamLayer.createSession(for: "event-123")

// With custom menu item
let menuItem = SLRCustomMenuItem(viewController: MyCustomVC())
menuItem.iconImage = UIImage(named: "custom_icon")
StreamLayer.createSession(for: "event-123", andAddMenuItems: [menuItem])

public func requestDemoStreams(
    showAllStreams: Bool,
    completion: @escaping (([SLRStreamModel]) -> Void)
)

public static func setAuthorizationBypass(
    token: String,
    schema: String
) async throws

public static func useAnonymousAuth() async throws

public static func isUserAuthorized() -> Bool

public static func isUserAnonymous() -> Bool

public static func logout()

public struct Auth

public struct SLRRequireAuthOptions: OptionSet

// Phone OTP flow
try await StreamLayer.Auth.requestOTP(phoneNumber: "+1234567890")
let authData = try await StreamLayer.Auth.authenticate(phoneNumber: "+1234567890", code: "1234")
print("Logged in as: \(authData.user.username)")

public protocol StreamLayerConfig: AnyObject

public class StreamLayerSilentModeConfig: StreamLayerConfig

StreamLayer.config = StreamLayerSilentModeConfig()

public struct ManagedGroupConfig

public init(
    watchPartyLandscapeInset: UIEdgeInsets,
    watchPartyInitialDraggableArea: SLRDraggableArea,
    managedGroupOverlayWidth: CGFloat
)
public init()

public struct SLRGamificationOptions

public init(
    globalLeaderBoardEnabled: Bool,
    invitesEnabled: Bool,
    isOnboardingEnabled: Bool,
    showGamificationNotificationOnboarding: Bool
)

public struct StatisticsDataOptions: StatisticsDataOptionsProtocol

public init(golfStatisticsStringUrl: String, golfStatisticsPollingTimer: Int)

public class func createOverlay(
    mainContainerViewController: UIViewController,
    overlayDelegate: SLROverlayDelegate,
    overlayDataSource: SLROverlayDataSource,
    sideBarDelegate: SLRSideBarDelegate? = nil
) -> SLRWidgetsViewController

let overlay = StreamLayer.createOverlay(
    mainContainerViewController: self,
    overlayDelegate: self,
    overlayDataSource: self
)
overlay.willMove(toParent: self)
addChild(overlay)
view.addSubview(overlay.view)
overlay.didMove(toParent: self)

public class func showOverlay(
    overlayType: StreamLayerOverlayType,
    mainContainerViewController: UIViewController,
    overlayDataSource: SLROverlayDataSource,
    sideBarDelegate: SLRSideBarDelegate? = nil,
    dataOptions: [String: Any]? = nil
) throws

public class SLRWidgetsViewController: UIViewController, Connectable

public class SLRWatchPartyStatusView: UIView, Connectable

public class SLRWatchPartyPillButton: UIButton

public class SLRDebugInfo

public static func createManagedGroupSession(
    for groupId: String,
    title: String,
    completion: @escaping SLRWatchPartySessionCreationBlock
)

// Get active watch party ID (nil if none)
public static func activeWatchParty() -> String?

// Subscribe to active watch party changes
public static func activeWatchParty(activeWP: @escaping (String?, Bool) -> Void)

// Open/close/toggle watch party
public static func openActiveWatchParty()
public static func closeActiveWatchParty()
public static func toggleMinifiedModeThumbnails(show: Bool)

// Register a custom Watch Party video plugin
public static func registerWatchPartyPlugin(_ plugin: SLRWatchParyServiceProtocol)

public protocol SLRManagedGroupSession

public struct SLRManagedGroup

public class SLRManagedGroupSessionProvider

public enum SessionError: Error

public typealias SLRWatchPartyMessageCompletion = (Error?) -> Void
public typealias SLRWatchPartyActionCompletion = () -> Void
public typealias SLRWatchPartySessionCreationBlock = (SLRManagedGroupSession?, Error?) -> Void

// Display an exposed ad or promotion
public class func showAd(_ adType: SLRAdType)

// Prefetch ad content for smooth display
public class func prefetchAd(
    _ adType: SLRAdType,
    expirationInterval: TimeInterval = 3600,
    completion: @escaping (Swift.Result<Void, Error>) -> Void
)

// Clear prefetched ads from memory
public class func clearPrefetchedAds()

// Dismiss the currently displayed exposed ad
public class func hideAd()

public class func showAd(_ adType: SLRAdType)

public class func prefetchAd(
    _ adType: SLRAdType,
    expirationInterval: TimeInterval = 3600,
    completion: @escaping (Swift.Result<Void, Error>) -> Void
)

public class func hideAd()

public class func clearPrefetchedAds()

public enum SLRAdType

public init(
    title: String,
    body: String,
    sponsorLogo: UIImage? = nil,
    backgroundImage: UIImage? = nil,
    vastTagURL: URL? = nil,
    layout: SLRFullBleedLayout = .left
)

// VAST-only convenience initializer
public init(vastTagURL: URL)

public init(
    title: String,
    body: String,
    sponsorLogo: UIImage? = nil,
    backgroundImage: UIImage? = nil,
    qrCode: QRCodeConfig? = nil,
    layout: SLRStandardADFullBleedLayout = .left
)

// tvOS QR-code CTA
public struct QRCodeConfig {
    public init(label: String, url: String, image: UIImage? = nil)
}

public init(
    media: SLRAdMedia,
    title: String? = nil,
    body: String? = nil,
    cta: SLRAdCTA? = nil,
    background: SLRAdBackground? = nil,
    timing: SLRAdTiming? = nil,
    sponsor: SLRAdSponsor? = nil,
    banner: SLRAdBanner? = nil
)

// Full-screen paused ad (iPad)
let config = SLRFullScreenAdConfiguration(
    title: "Sponsored Content",
    body: "Check out our latest offers",
    sponsorLogo: UIImage(named: "sponsor"),
    backgroundImage: UIImage(named: "bg")
)
StreamLayer.showAd(.fullScreen(configuration: config))

// Transparent background loaded in a WKWebView from a raw URL
let adURL = URL(string: "https://example.com/pause-ad.html")!
StreamLayer.showAd(.transparentBackground(url: adURL))

// Transparent background loaded by ad-server slot (bell-ad proxy resolves the URL)
StreamLayer.showAd(.transparentBackground(url: adURL, slot: "/12345/pause_ad_ctv"))

// Transparent background that parses a VAST tag and renders the NonLinear / Companion image.
// Fires VAST <Impression> pixels on display and <NonLinearClickTracking> pixels on tap.
let vastURL = URL(string: "https://example.com/vast.xml")!
StreamLayer.showAd(.transparentBackgroundVAST(vastTagURL: vastURL))

// Host-driven sidebar promotion
let promo = SLRSidebarPromotionAdConfiguration(
    media: SLRAdMedia(image: .url(imageURL)),
    title: "Save 20%",
    body: "Limited-time offer"
)
StreamLayer.showAd(.sidebarPromotion(configuration: promo))

// Prefetch for later (works for fullScreen with VAST and for transparentBackgroundVAST)
StreamLayer.prefetchAd(.transparentBackgroundVAST(vastTagURL: vastURL)) { result in
    switch result {
    case .success: print("Cached")
    case .failure(let error): print("Failed: \(error)")
    }
}

// Full-screen ad with a QR-code CTA
let config = SLRFullScreenAdConfiguration(
    title: "Sponsored Content",
    body: "Scan to learn more",
    sponsorLogo: UIImage(named: "sponsor"),
    backgroundImage: UIImage(named: "bg"),
    qrCode: .init(label: "Scan me", url: "https://example.com/offer")
)
StreamLayer.showAd(.fullScreen(configuration: config))

// Sidebar (L-bar) promotion
let promo = SLRSidebarPromotionAdConfiguration(media: SLRAdMedia(image: .url(imageURL)))
StreamLayer.showAd(.sidebarPromotion(configuration: promo))

public enum SLRPausedAdType

public struct SLRPausedAdConfiguration

public init(
    title: String,
    body: String,
    sponsorLogo: UIImage? = nil,
    backgroundImage: UIImage? = nil,
    vastTagURL: URL? = nil,
    layout: SLRFullBleedLayout = .left
)

public init(vastTagURL: URL)

public struct SLRResumeButtonConfiguration

public init(content: Content, position: Position = .defaultLandscape)

public static func image(_ image: UIImage, size: CGSize, position: Position = .defaultLandscape) -> SLRResumeButtonConfiguration
public static func text(_ text: String, position: Position = .defaultLandscape) -> SLRResumeButtonConfiguration
public static var hidden: SLRResumeButtonConfiguration

public struct SLRActionClicked

public struct SLRActionShown

public struct SLRStreamModel

public struct SLRStreamProgram

public init(title: String, startTime: String, endTime: String)

public struct SLRAuthData

public struct SLRAuthUser: Codable

@objc
public class SLRInviteData: NSObject

@objc
public class SLRAuthenticatedUser: NSObject

@objc
public class SLREventSession: NSObject

public struct SLRWatchPartySessionMeta

public class AuthUser: Codable

public init(id: String, username: String, name: String?, avatar: String?, alias: String?, publicName: String?)

// Prepare audio session for general playback (call on stream start)
public static func prepareSessionForGeneralAudio() throws

// Deactivate the audio session
public static func closeAudioSession() throws

// Fix lowered volume during/after voice calls
public static func applyVideoSoundFix()

// When player item is ready
observer = playerItem.observe(\.status, options: [.new]) { item, _ in
    guard item.status == .readyToPlay else { return }
    StreamLayer.applyVideoSoundFix()
}

// Handle push notification
@discardableResult
public class func handlePushNotification(
    _ center: UNUserNotificationCenter?,
    userInfo: [AnyHashable: Any],
    background: Bool
) -> Bool

// Upload APNs device token
public class func uploadDeviceAPNsToken(deviceAPNsToken: String)

// Remove APNs token on logout
public class func removeDeviceAPNsToken()

// Handle Branch/deep link
@objc
public class func handleDeepLink(params: [AnyHashable: Any]?) -> Bool

// In AppDelegate
func application(_ application: UIApplication,
                 didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    let token = deviceToken.map { String(format: "%02.2hhx", $0) }.joined()
    StreamLayer.uploadDeviceAPNsToken(deviceAPNsToken: token)
}

// Handle push
func userNotificationCenter(_ center: UNUserNotificationCenter,
                            didReceive response: UNNotificationResponse) {
    StreamLayer.handlePushNotification(center,
                                       userInfo: response.notification.request.content.userInfo,
                                       background: true)
}

public class SLRAuthFlow

public init(authProvider: SLRAuthFlowProvider)

public func show(
    from viewController: UIViewController,
    options: StreamLayer.Auth.SLRRequireAuthOptions,
    completion: @escaping (Error?) -> Void
)

let authFlow = SLRAuthFlow(authProvider: myAuthProvider)
authFlow.show(from: self, options: .all) { error in
    if let error { print("Auth failed: \(error)") }
    else { print("Auth succeeded") }
}

public class SLRProfileFlow

public init(profileProvider: SLRAuthFlowProfileProvider)
public func show(from viewController: UIViewController)

public class PortraitNavigationController: UINavigationController

public protocol SLROverlayDataSource: AnyObject

public protocol SLROverlayDelegate: AnyObject

public protocol StreamLayerDelegate: AnyObject

public protocol StreamLayerInviteLinkHandler: AnyObject

public protocol SLRLBarDelegate: AnyObject

public protocol SLRSideBarDelegate: AnyObject

public protocol SLROverlayLoggerDelegate: AnyObject

public protocol SLRBugseeDelegate: AnyObject

@objc public protocol SLRTimecodeProvider: AnyObject

public protocol SLRTimeObservable

public protocol SLRCustomMenuProtocol: AnyObject

public class SLRCustomMenuItem: SLRCustomMenuProtocol

public init(viewController: UIViewController)

public protocol SLRAuthFlowProvider

public protocol SLRAuthFlowProfileProvider

public protocol StatisticsDataOptionsProtocol

public protocol SLRWatchParyServiceProtocol

public protocol SLRWatchPartyServiceDelegate: AnyObject

public protocol SLRGooglePALServiceProtocol

final public class StreamLayer

public class func initSDK(with key: String, isStagingEnv: Bool = false)

@discardableResult
public class func createSession(for eventId: String, timeCodeProvider: SLRTimecodeProvider? = nil) -> SLREventSession

public class func createOverlay(
    containerViewController: UIViewController,
    contentView: UIView,
    delegate: StreamLayerTVOSDelegate? = nil
) -> UIViewController

public class func startADBreak()
public class func stopADBreak()
public class func setAnonymousAuth() async throws
public class func clearAuthCreds()

public class func showPausedAd(_ adType: SLRPausedAdType)
public class func prefetchPausedAd(
    _ adType: SLRPausedAdType,
    expirationInterval: TimeInterval = 3600,
    completion: @escaping (Swift.Result<Void, Error>) -> Void
)
public class func clearPrefetchedPausedAds()
public class func hidePausedAd()

public class func registerPALPlugin(_ plugin: SLRGooglePALServiceProtocol)
public class func servicesDebugInfo() -> [(section: String, items: [(title: String, value: String)])]
public class func sdkVersion() -> String

public func requestDemoStreams(showAllStreams: Bool = true, completion: @escaping (([SLRStreamModel]) -> Void))
public func makeLoggerViewController() -> UIViewController

public protocol StreamLayerTVOSDelegate: AnyObject

public protocol SLRConfigurationProtocol

public struct SLRConfiguration: SLRConfigurationProtocol

public class SLREventSessionProvider

public protocol SLRTimecodeProvider: AnyObject

public struct SLRFullScreenAdConfiguration

public init(
    title: String,
    body: String,
    sponsorLogo: UIImage? = nil,
    backgroundImage: UIImage? = nil,
    qrCode: QRCodeConfig? = nil,
    layout: SLRStandardADFullBleedLayout = .left
)

// QR-code CTA (tvOS only)
public struct QRCodeConfig {
    public init(label: String, url: String, image: UIImage? = nil)
}

public enum SLRStyle: String

public enum SLROverlayMode: String

public enum SLRAudioSessionType: Int

@objc public enum StreamLayerOverlayType: Int

public struct SLRNotificationsMode: OptionSet

public enum SLRVideoPlayerProviderType

public enum SLRReferenceViewMode

public enum SLRFullBleedLayout

public enum SLRDraggableArea: CaseIterable

public enum StreamLayerLocalization: String

public enum SLRStandardADFullBleedLayout

// Track debug info changes
public class func debugInfo(listener: @escaping (SLRDebugInfo) -> Void)

// Get keyboard-handling exclusions
public class func disableKeyboardHandlingClasses() -> [UIViewController.Type]

// Google PAL plugin registration
public static func registerPALPlugin(_ plugin: SLRGooglePALServiceProtocol)

// Logger initialization
public class func initSwiftBeaverLogger(
    with appID: String,
    appSecret: String,
    encryptionKey: String,
    loggerDelegate: SLROverlayLoggerDelegate? = nil
)