VPKit SDK Reference — 2.11.8

Basic usage

VPKit is the public interface of the framework: initialise the SDK with your application credentials (setApplicationId:clientId:clientSecret:), choose production or sandbox (setProduction:), and optionally style the UI through VPKit.styles.

Display your media in a VPKPreview (a UIImageView subclass) holding a VPKImage (a UIImage subclass carrying a veep identifier or the media URL). Tapping a preview with veep content presents VPKVeepViewer, which plays images and videos with interactive tracks and an in-app browser. The preview presents and dismisses the viewer itself; set its passThroughDelegate to observe taps.

• VPKit
• VPKPreview and VPKPreviewPassThroughDelegate
• VPKImage
• VPKVeepViewer
• VPKStyles
• Event constants

Veep creation (the editor and object tracker) is provided by the separate VPKitMaker SDK.

Installation

Swift Package Manager (public): add https://github.com/veepionyc/VPKit-spm at version 2.11.8 and pick the VPKit or VPKit product.

Manual: download VPKit (or the static variant) from the 2.11.8 release, add the xcframework to your target and choose Embed & Sign for the dynamic variant. VPKit also needs the dotveep framework, which the Swift package resolves for you.

CocoaPods: 2.11.x is distributed through Veepio’s private Specs repository (pod 'VPKit', '2.11.8'); contact sdk_support@veepio.com for access. The public CocoaPods trunk carries VPKit up to 2.10.3.

Requirements

• iOS 12 or later; apps built with the iOS 27 SDK must adopt the UIScene life cycle.
• VPKit ships a privacy manifest and collects no advertising identifier unless you opt in with +[VPKit sendIDFA:] (see its documentation for the App Tracking Transparency obligations).

What’s new since 2.10

See the VPKit documentation for the full change list. Highlights: analytics delivered to the Veepio events collector (setAnalyticsCollectorURL:), IDFA collection as an explicit ATT-gated opt-in, layout fixes for iOS 18, 26 and 27, portrait media sizing, larger track touch targets, and smooth open and close transitions for image and video veeps.