SnapscreenSnapConfiguration

@interface SnapscreenSnapConfiguration : 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.

  • Search for TV results of type SnapscreenTvSearchResult

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL searchForTvResults;

    Swift

    var searchForTvResults: Bool { get set }

  • Search for advertisements of type SnapscreenAdvertisementSearchResult

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL searchForAdvertisements;

    Swift

    var searchForAdvertisements: Bool { get set }

  • Search for sport event results of type SnapscreenSportEventSearchResult

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL searchForSportEvents;

    Swift

    var searchForSportEvents: Bool { get set }

  • Perform automatic snapping (provided that the specified result types support autosnapping

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) BOOL automaticSnap;

    Swift

    var automaticSnap: Bool { get set }

  • The minimum interval between automatic snap attempts in seconds; Defaults to 0.5

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    NSTimeInterval autosnapIntervalInSeconds;

    Swift

    var autosnapIntervalInSeconds: TimeInterval { get set }

  • The time interval after which automatic snapping stops when no results are found; Defaults to 30 seconds

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    NSTimeInterval autosnapTimeoutDuration;

    Swift

    var autosnapTimeoutDuration: TimeInterval { get set }

  • Perform quadrangle detection and highlighting. Defaults to YES

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL quadrangleDetection;

    Swift

    var quadrangleDetection: Bool { get set }

  • Whether to use a custom logo in snap view or the original snapscreen logo. If true and no logo is provided, no logo is shown

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL useCustomSnapLogo;

    Swift

    var useCustomSnapLogo: Bool { get set }

  • A custom logo to display during snapping. The logo is shown as is and not modified in any way

    Declaration

    Objective-C

    @property (nonatomic, strong) UIImage* customSnapLogoImage

    Swift

    var customSnapLogoImage: NSImage! { get set }

  • The size for the custom snap logo. If not provided the implicit image size will be used

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    CGSize customSnapLogoImageSize;

    Swift

    var customSnapLogoImageSize: CGSize { get set }