Latest 2.0.2
Homepage https://github.com/vi-ai/vi-iOS-SDK
License MIT
Platforms ios 8.0
Authors

video intelligence iOS SDK v2.0

Version
License
Platform

Requirements

The vi iOS SDK supports iOS v8 and above and requires ARC.

Enable support for HTTP ads

Apple has introduced HTTPS changes that may not be supported by all Advertisers. Enforcing the need for secure ads only will impact your potential revenue.
In order to support ad requests that are made using HTTP instead of HTTPS, you need to make the following changes in your Info.plist:

Add the 'App Transport Security Settings' node, and
set 'Allow Arbitrary Loads' to YES

Installation

Using CocoaPods (prefered)

vi IOS SDK is available through CocoaPods.
To install it, simply add the following line to your Podfile:

pod 'VISDK'

Install the pod(s) by running pod install.
Include vi IOS SDK wherever you need it with import VISDK.

Using Dynamic Framework

You can also add the vi iOS SDK as a dynamic framework to your project or workspace.

Get the latest version of VISDK.framework , copy it to your project’s working directory
Open Xcode, select your target, go to General tab. Add VISDK.framework as Embedded Binary.
Include VISDK wherever you need it with import VISDK.

Usage

As part of vi iOS SDK v2.0 you can choose to display both In-Stream or Interstitial video ads.
In both cases, you would need to provide a placement and a container where the ad is to be displayed.
Make sure you hold the reference on the instance of ViAd while the ad is being rendered.

Always initialize the vi IOS SDK while launching your application

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    VISDK.sharedInstance()
    return true
}

Setting up an In-Stream ad

@IBOutlet var adContainer: UIView!  // ad container. Ensure it's a part of view hierarchy
var inStreamAd: VIVideoAd!          // object to manage the ad

override func viewDidLoad() {
    super.viewDidLoad()
    // Get PlacementId from ad console

    let placement = VIPlacement("Your_placement_Id", options: nil);
    inStreamAd = VISDK.sharedInstance().createVideoAd(for: placement, inContainer: adContainer)
    inStreamAd.startsWhenReady = true
    inStreamAd.delegate = self
    inStreamAd.load()
}

Implement two delegate methods which are rather informative and doesn’t require any action from your side

func adDidReceive(_ event: VIAdEvent) {
    switch event.type {
    case .completed: break
    case .clicked: break
    case .closed: break
    case .expired: break
    case .loaded: break
    case .paused: break
    case .resumed: break
    case .started: break
    }
}

func adDidReceiveError(_ error: Error) {
    //your code
}

with one exception – start the ad manually if startsWhenReady is NO.

func adDidReceive(_ event: VIAdEvent) {
    switch event.type {
    case .loaded:
        inStreamAd.start()
    break
    }
}

you can control ad playback

inStreamAd.start()

inStreamAd.pause()

inStreamAd.resume()

inStreamAd.close()

Setting up an Interstitial ad

Interstitial ads are cached locally which could take time depending on existing network conditions. Therefore, we recommend that you initiate the ad load process in advance to enhance the user experience.

let placement = VIPlacement("plttwmion1hu5al7mmu", options: nil);
interstitialAd = VISDK.sharedInstance().createInterstitialAd(for: placement)
interstitialAd.delegate = self
interstitialAd.load()

Once the ad is loaded, a corresponding event will be returned via the following callback. We strongly recommend checking whether the ad is ready isReady before displaying it.

func adDidReceive(_ event: VIAdEvent) {
    switch event.type {
    case .loaded:
        if interstitialAd.isReady {
            interstitialAd.show(from: self)
        }
    break
    }
}

All callbacks are fired from the main queue. You will not be required to perform any resource cleanup steps. All ad content is automatically removed once the ad has been displayed.

Client Side Mediation: How to enable Ad mediation support

vi IOS SDK supports 3 ad providers:

Installation

Add files for Mediation you need from above folder links to your projects.

Mediation adapters should be added to Vi Ads where you want mediation to be present. Here is simple Mopub example:


// Create interstitialAd
let placement = VIPlacement("your placement ID", options: nil)
let ad = VISDK.sharedInstance().createInterstitialAd(for: placement)
ad?.delegate = self

// Register Mediation adapter.
let adapter = MopubVIInterstitialAdapter(placementID: "your Mopub placement ID")
ad?.registerMediation(adapter)

That’s it. When there is no available vi Direct demand, the Mopub ad will be sourced and displayed in your application.

You can register several Mediation adapter of a different kind:

let adapter1 = MopubVIInterstitialAdapter(placementID: "your Mopub placement ID")
let adapter2 = FacebookVIInterstitialAdapter(placementID: "your Mopub placement ID")
ad?.registerMediations([ adapter1, adapter2 ])

Mediation Samples

Detailed samples with Mediation implementations are provided in Example.

To run the Example project, clone the repo, and run pod install from the Example directory first.

External tracker: How add external trackers for ViAdsSDK

ViAdSDK provides ability to add global trackers on all events that happens within the SDK. This tracking should be registered just after SDK initialization. This can be achieved with implementation of VIExternalTracker protocol.

For all events, the placementID determines on which placement the event occurred.

Apart from custom events, the vi SDK also includes a pre-built adapter for count.ly analytics.

count.ly adapter usage

Copy source files from Folder link: Countly to your project. And register CountlyExternalTracker at start of your App e.g. in AppDelegate:


func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    //Initialize Counlty
    let config = CountlyConfig()
    config.appKey = "Your countly app key"
    config.host = "Your countly host url path"

    Countly.sharedInstance().start(with: config)

    //Register externalTracker to VISDK
    VISDK.sharedInstance().register(CountlyExternalTracker())

    return true
}

Need help?

Get in touch with as at [email protected] so we can help you get started!

Author

video intelligence
more information

License

vi IOS SDK is available under the MIT license. See the LICENSE file for more info.

Latest podspec

{
    "name": "VISDK",
    "version": "2.0.2",
    "summary": "Add in-app video advertisement with VISDK",
    "description": "Add in-app video advertisement with VISDK. Use it carefully and enjoy.",
    "homepage": "https://github.com/vi-ai/vi-iOS-SDK",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": {
        "VISDK": "[email protected]"
    },
    "source": {
        "git": "https://github.com/vi-ai/vi-iOS-SDK.git",
        "tag": "2.0.2"
    },
    "platforms": {
        "ios": "8.0"
    },
    "vendored_frameworks": "VISDK/VISDK.framework",
    "source_files": "VISDK/VISDK.framework/Headers/*.h",
    "public_header_files": "VISDK/VISDK.framework/Headers/*.h"
}

Pin It on Pinterest

Share This