Classes

The following classes are available globally.

  • Represents an access token for accessing the Snapscreen API.

    Note: This class is only intended for internal use and should not be used by SDK consumers!

    See more

    Declaration

    Objective-C

    @interface SnapscreenAccessToken : NSObject

    Swift

    class SnapscreenAccessToken : NSObject

  • Holds the current Access Token for communicating with the Snapscreen API.

    Note: This class is only intended for internal use and should not be used by SDK consumers!

    See more

    Declaration

    Objective-C

    @interface SnapscreenAccessTokenHolder : NSObject

    Swift

    class SnapscreenAccessTokenHolder : NSObject

  • Represents an advertisement

    See more

    Declaration

    Objective-C

    @interface SnapscreenAdvertisement : NSObject

    Swift

    class SnapscreenAdvertisement : NSObject

  • Represents the result from an advertisement search.

    See more

    Declaration

    Objective-C

    @interface SnapscreenAdvertisementSearchResult : NSObject

    Swift

    class SnapscreenAdvertisementSearchResult : NSObject

  • Represents a quadrangle on the screen that contains a search result.

    See more

    Declaration

    Objective-C

    @interface SnapscreenResultQuadrangle : NSObject

    Swift

    class SnapscreenResultQuadrangle : NSObject

  • Represent the result from a search.

    See more

    Declaration

    Objective-C

    @interface SnapscreenSearchResult : NSObject

    Swift

    class SnapscreenSearchResult : NSObject

  • Base class for all result entries returned from a snap.

    Declaration

    Objective-C

    @interface SnapscreenSearchResultEntry : NSObject

    Swift

    class SnapscreenSearchResultEntry : NSObject

  • Configuration object to be passed when snapping. Allows you to specifiy what result types you are interested in and additional behaviour of the snapping process.

    See more

    Declaration

    Objective-C

    @interface SnapscreenSnapConfiguration : NSObject

    Swift

    class SnapscreenSnapConfiguration : NSObject

  • Represents a match

    See more

    Declaration

    Objective-C

    @interface SnapscreenSportEvent : NSObject

    Swift

    class SnapscreenSportEvent : NSObject

  • Represents a competitor in a sport event

    See more

    Declaration

    Objective-C

    @interface SnapscreenSportEventCompetitor : NSObject

    Swift

    class SnapscreenSportEventCompetitor : NSObject

  • Represents the result from a sports event search.

    See more

    Declaration

    Objective-C

    @interface SnapscreenSportEventSearchResult : NSObject

    Swift

    class SnapscreenSportEventSearchResult : NSObject

  • Represents a programme of the electronic programme guide (EPG) of a TV channel

    See more

    Declaration

    Objective-C

    @interface SnapscreenEpgUnit : NSObject

    Swift

    class SnapscreenEpgUnit : NSObject

  • Represents information about credits of an epg unit

    See more

    Declaration

    Objective-C

    @interface SnapscreenEpgUnitCredits : NSObject

    Swift

    class SnapscreenEpgUnitCredits : NSObject

  • Represents information about a person that is part of an EPG Unit in some form

    See more

    Declaration

    Objective-C

    @interface SnapscreenEpgUnitPerson : NSObject

    Swift

    class SnapscreenEpgUnitPerson : NSObject

  • Represents a TV channel with the internal Snapscreen representation

    See more

    Declaration

    Objective-C

    @interface SnapscreenTvChannel : NSObject

    Swift

    class SnapscreenTvChannel : NSObject

  • Represent the result from a TV search.

    See more

    Declaration

    Objective-C

    @interface SnapscreenTvSearchResult : NSObject

    Swift

    class SnapscreenTvSearchResult : NSObject

  • Customer configuration with specific snapscreen settings for this customer

    See more

    Declaration

    Objective-C

    @interface SnapscreenCustomerConfiguration : NSObject

    Swift

    class SnapscreenCustomerConfiguration : NSObject

  • Information about a shared clip.

    See more

    Declaration

    Objective-C

    @interface SnapscreenClipShareInformation : NSObject

    Swift

    class SnapscreenClipShareInformation : NSObject

  • View Controller to provide clip snapping functionality as a standalone feature without any of the surrounding flow and UI.

    See more

    Declaration

    Objective-C

    @interface SnapscreenClipSnapViewController

    Swift

    class SnapscreenClipSnapViewController

  • Configuration object for customizing the appearance of the clip sharing UI.

    See more

    Declaration

    Objective-C

    @interface SnapscreenClipSharingConfiguration : NSObject

    Swift

    class SnapscreenClipSharingConfiguration

  • Navigation Controller that contains a SnapscreenClipSharingViewController if you want to present the UI with a NavigationBar.

    You can customize the NavigationBar and the NavigationItem of the rootViewController as preferred - by default the SnapscreenClipSharingViewController adds a Cancel item if presented modally.

    See more

    Declaration

    Objective-C

    @interface SnapscreenClipSharingNavigationController

    Swift

    class SnapscreenClipSharingNavigationController

  • ViewController to present clip sharing. Automatically presents the tutorial if necessary, guides the user through snapping and presents a clip sharing UI at the end.

    Pass the appropriate styling information and tutorial content via the configuration and implement the delegate to receive callbacks during the sharing process.

    See more

    Declaration

    Objective-C

    @interface SnapscreenClipSharingViewController

    Swift

    class SnapscreenClipSharingViewController

  • Configuration object of a single page in the tutorial

    See more

    Declaration

    Objective-C

    @interface SnapscreenClipSharingTutorialContent : NSObject

    Swift

    class SnapscreenClipSharingTutorialContent

  • View Controller for presenting recognized snap results when result is not unique and returns multiple possible matches

    Declaration

    Objective-C

    @interface SnapscreenSnapResultsViewController

    Swift

    class SnapscreenSnapResultsViewController

  • SnapscreenARSnapViewController offers the snapping logic from Snapscreen to your application and enrich it via AR-like features. Instantiate via SnapscreenKit and then display it in your application. The recommended way to present the view controller is to present it as a modal view that covers the whole screen.

    Use the AR delegate callbacks to get information about the snapping process. In any case you are responsible to dismiss the view controller again.

    To customize the appearance of the viewfinder and zoom level indicator set the tintColor accordingly. To customize the color of the navigation bar and it’s bar items use the default UIAppearance API calls.

    The snap button is automatically hidden in this view controller since AR only makes use of autosnapping.

    Please note that the standard SnapscreenSnapViewControllerDelegate (which is accessible via the view controller’s delegate property) is not used in this case, but all relevant callbacks occur via the arDelegate.

    See more

    Declaration

    Objective-C

    @interface SnapscreenARSnapViewController : SnapscreenSnapViewController

    Swift

    class SnapscreenARSnapViewController : SnapscreenSnapViewController

  • SnapscreenSnapViewController offers the snapping logic from Snapscreen to your application. Instantiate via SnapscreenKit and then display it in your application. The recommended way to present the view controller is to present it as a modal view that covers the whole screen.

    Use the delegate callbacks to get information about the snapping process. In any case you are responsible to dismiss the view controller again.

    To customize the appearance of the viewfinder, zoom level indicator and snap button, set the tintColor or the snapButtonImage accordingly. To customize the color of the navigation bar and it’s bar items use the default UIAppearance API calls.

    See more

    Declaration

    Objective-C

    @interface SnapscreenSnapViewController

    Swift

    class SnapscreenSnapViewController

  • SnapscreenKit offers integration of the Snapscreen functions in your app. Before using, make sure to initially SnapscreenKit with the appropriate clientID and clientSecret and provide optional additional handlers.

    See more

    Declaration

    Objective-C

    @interface SnapscreenKit : NSObject

    Swift

    class SnapscreenKit : NSObject

  • SnapscreenSnapper offers a direct API for getting snap and quadrangle results. This offers the ability to build more immersive experiences with custom UIs while still providing snap functionality.

    See more

    Declaration

    Objective-C

    @interface SnapscreenSnapper : NSObject

    Swift

    class SnapscreenSnapper : NSObject