Getting Started

Overview

The standalone Swift package will contain all the necessary elements to bring TSL experience on mobile. This SDK will not only provide the essential components but also offer an example of how to customize the TSL Swift package to enhance the user experience.

Core Features

A set of core TalkShopLive functions, written in Swift. Core will for the backbone of all other SDK components in the library by providing access to TalkShopLive Services and utility functions. Core will also contain the fundamentally important functionality for reporting analytics to TalkShopLive’s Collector Analytics service, so that all other components can self-manage collecting telemetry actions.

Concepts
Show
Use this to retrieve information about the live stream, VOD, and trailers.

Chat
Chat is available as a feature in both live and VOD shows. A user (guest or registered) will be generated upon starting the Chat. Refer to the User Token section for further details.

Swift Package Manager

You can add TSL SDK by going to XCode > File > Swift Packages > Add or by adding it in your Package.swift file.

dependencies: [ 
    .package(url: "https://github.com/Talkshoplive/ios-sdk.git", from: "1.0.0") 
]

📘

SDK under development. Please use the provided released version

Initializing

Import the module named TalkShopLive inside your AppDelegate:


import TalkShopLive // \<- Here is our TalkShopLive module import.

Initialize the SDK using clientKey:

Parameters:

clientKey: Given secured client key.

debugMode: Print console logs if true.

testMode: Switch to staging if true. False will connect to production environment.

dnt: Do not track, disables the app data collection (PII related data)

Concurrent instances of the TalkShopLiveSDK are not supported; only one instance should exist at any given time.

// Init instructions.
//        Talkshoplive.TalkShopLive(clientKey: "YourClientKey", debugMode: true/false, testMode: true/false, dnt: true/false)
let TSL = Talkshoplive.TalkShopLive(clientKey: "yourkeyhere",debugMode: true,testMode: true)

🚧

Concurrent instances of the TalkShopLiveSDK are not supported; only one instance should exist at any given time.