About

This library is for embedding video streams from the Videeo commerce platform into your iOS application.

Prerequisites

To integrate Videeo streams into your application, you must have an active account. To create an account go to (https://www.videeo.live/get-started/)

Requirements

Videeo SDK is compatible with:

• iOS 14 or greater.
• Xcode 13+ or greater.
• Swift 5.6 or greater.

How to add the Videeo SDK to your project.

The Videeo SDK can be added via Swift Package Manager, CocoaPods, or manually imported.

SPM

In your Xcode project, select File > Swift Packages > Add Package Dependency and enter the following URL: https://github.com/CommentSold/iOS-Videeo/

If you are new to Xcode's Swift Package Manager integration, please refer to Apple's documentation on Adding a Package Dependency to Your App

CocoaPods

Add VideeoSDK in your Podfile: pod VideeoSDK and then run pod install.

If you are new to CocoaPods, please refer to the documentation on CocoaPods Guides

Manual XCFramework Integration

• Download the SDK binary from the latest release and unzip the XCFramework into your project structure.
• Open your Xcode project, select your project file, and select your app target and the General tab.
• Drag the unzipped VideoSDK.xcframework into the section of the General tab called Frameworks, Libraries, and Embedded Content. Make sure you select Embed and Sign.
• Your project should look like the following:

Using the Videeo SDK

Sample Code

There are example projects for both Swift (UIKit and SwiftUI) and Obj-c in the Demo folder for this repo.

Initialization

To initialize the Videeo SDK you will need the shop ID.

• Log in to the admin dashboard (https://go.videeo.com).
• Click the Connect Channel link.
• Click the Get Embed Code button.
• Copy the shopName value from the script tag.

The VideeoManager is a singleton class that exposes all of the public APIs for the Videeo SDK. Before calling any of the VideeoManager functions, you must first call the initialize function and pass a VideeoConfig.

Detecting Live Streams

Once initialized, the VideeoManger will begin checking to see if a live event for your shop is currently running. When the VideeoManger detects the live stream has started or stopped, it will dispatch a videeoLiveStatusChanged notification with the updated state. You can also check the VideeoManager.instance.isLive property at any time to check the current status.

NotificationCenter.default.addObserver(
	forName: .videeoLiveStatusChanged,
	object: VideeoManager.instance,
	queue: nil) { notification in
		if let userInfo = notification.userInfo, let isLive = userInfo["isLive"] as? Bool {
			print("The live stream is happening: \(isLive)")
		}
	}

When the app detects that a live stream is running, you can use the VideeoManager.instance.getLiveStreamViewController function to create the VideeoViewController. We recommend presenting the VideeoViewController fullscreen for the best user experience. This same functionality is also available to SwiftUI by calling VideeoManager.instance.getLiveStreamView.

VideeoStreamDelegate

The videeo stream delegate allows the host app to react to events that happen in stream viewer. The host app must provide a VideeoStreamDelegate when presenting a Videeo stream.

/// The productTapped function will be triggered when the user taps on the product, either
/// in the product overlay or in the bottom product tray.
/// The default behavior will show the product details in a web view.
/// To override, simply return your own custom UIViewController.
/// - Parameter product: The product that has been selected.
/// - Returns: A view controller to show when a product in the botton tray is tapped.
/// If no view controller is provided, then a selected product will be shown in a web view..
func productTapped(product: VideeoProduct) -> UIViewController?

/// The closeTapped function will be triggered when the it is time to close the stream viewer.
/// Since the host app has presented the stream viewer, the host app will be responsible
/// to close the stream viewer in the appropriate manner.
func closeTapped()

/// A guest user has performed an action that requires authentication, like trying to comment
/// on a live stream.  This delegate function provides an opportunity for the host app
/// to prompt the user for authentication.
func userAuthenticationRequired()

/// The streamEnded function is called when the current stream ends.  The default behavior
/// will present a dialog indicating that the live stream has ended, and allow the user to dismiss
/// the videeo view controller.  Return true to override the default behavior.
/// - Returns: Boolean indicating if the host app is overriding the default behavior.
func streamEnded() -> Bool

/// The userRemovedFromLive function is triggered when the user has been blocked by the shop
/// admin for bad behavior.  The default behavior is to do nothing.  Return true to override the default behavior.
/// - Returns: Boolean indicating if the host app is overriding the default behavior.
func userRemovedFromLive() -> Bool

Videeo Stream Replays

Replays are Videeo streams saved for later consumption. To display the list of replays, you can call the VideeoManager.instance.getReplaysViewController. The replays view controller will display the list of replays and allow the user to watch a specific replay. This same functionality is also available to SwiftUI by calling VideeoManager.instance.getReplaysView.