VLPlayer SDK - iOS

VLPlayer SDK - iOS
(version 2.4.4)

Setup

First, you’ll need to install the framework provided to you into your iOS app. Add the VLPlayer.framework to your target in the project editor by adding it as an Embedded Binary in the General section. You will also need the GoogleInteractiveMediaAds.framework and AmazonIVSPlayer.framework as an embedded binary. This SDK requires that you are using Xcode 12.5 nd Swift 5. You would need to select “Audio, AirPlay and Picture In Picture” option in Sign- ing & Capabilities under Background Modes.

Next, import the header - VLPlayer in the View-Controller you will use to load the VLPlayer iOS SDK. Developers can interact with the Player SDK by using the VLPlayer class:

Once the header is imported in your View-Controller class, you simply need to initialize the VLPlayer iOS SDK:

initVLPlayer() method initialises SDK object & allows your code to add configurations to player. You may use these configuration methods to manage Video Player & its layer:

List of supported Configuration Methods:

After configuration, you would need to set source of video to SDK player everytime a new instance of video player needs to be created. This method requires attributes to be passed, mentioned below.
Important: Please add setSource method on main thread to ensure seamless working of player & maintaining view hierarchy. Use DispatchQueue.main.async.

initVLPlayer & setSource methods needs to be used for every new instance of player.
Having separate init methods for each player makes sure we can have different configs for each player instance.

setSource method has a callback method as a parameter, which has player which you can add resize based on usage.
Initialize this method with -

• Valid ViewLift Token

• A ViewLift video ID

• Video Player Tag - String val for tagging video player instance - this tag will come with every event to identify the instance of player

• Bool value to set if video player has to be launched in fullscreen mode only

• Custom Controls view to replace default VL player controls

• adUrl - URLs for ads

• playerProgressInterval - Specify interval when to get progress of player. Default value is 30 seconds and value cannot be less than 1.

• is CustomLoaderAdded - Tell if custom loader indicator is being added. Default value is false.

• Callback → which provides better visibility about the response of this method, including boolean value to provide info if this method worked successfully or not & a video player view instance.

Methods & Events
Below, you’ll find the list of supported methods and events for the player.

To listen for events, you need to first add the videoPlaybackDelegate to your UIViewController class. After that, you can add the following line just before you initialize the player:

List of supported Methods:

List of supported Events:

Video Fetch Errors

VLPlayer SDK responds with descriptive errors that may happen due to network, wrong video id/ token passed. iOS SDK offers error as an object - VLError. This comes as an attribute to videoFetchError() event.
VLError comprise of 5 variables:
isSuccess: Bool
isPlayable: Bool
errorCode: String
errorMessage: String
vl_errorCode: String

Example: (Used in sample code)
Is content playable - false (isPlayable)
Content Fetched successfully - false (isSuccess)
Error Code - Token Invalid (errorCode)
Error Message - Unauthorized (errorMessage)
Error VL Code - VL_401 (vl_errorCode)

Possible ViewLift Errors:

New in this version :

• Added Support for showing custom loader indicator by hiding default player loader.
• Added Support to get player progress by adding custom interval.

For questions or issues regarding the Player SDK or integrations, contact support@viewlift.com.