SnapscreenClipSharingConfiguration

@interface SnapscreenClipSharingConfiguration : NSObject

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

  • Content to be displayed in the tutorial

    Declaration

    Objective-C

    @property (nonatomic, strong, readwrite)
    NSArray<SnapscreenClipSharingTutorialContent *> *_Nonnull tutorialContent;

  • Optional logo that is displayed above the tutorial content (and does not scroll with the tutorial content)

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) UIImage* tutorialLogoImage

    Swift

    var tutorialLogoImage: UnsafeMutablePointer<Int32>? { get set }

  • Maximum Height constraint that is applied to the tutorial logo image on the tutorial page - defaults to -1 which means that the full image height is used

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    CGFloat maximumTutorialLogoImageHeight;

    Swift

    var maximumTutorialLogoImageHeight: Int32 { get set }

  • Large sponsor image that is displayed on the snap screen

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) UIImage* largeSponsorImage

    Swift

    var largeSponsorImage: UnsafeMutablePointer<Int32>? { get set }

  • Large sponsor image that is displayed on the tutorial screen

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) UIImage* largeTutorialSponsorImage

    Swift

    var largeTutorialSponsorImage: UnsafeMutablePointer<Int32>? { get set }

  • Small sponsor image that is displayed in the trimming UI

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) UIImage* smallSponsorImage

    Swift

    var smallSponsorImage: UnsafeMutablePointer<Int32>? { get set }

  • Image that is displayed as the background in the tutorial - if nil a white screen is shown

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) UIImage* tutorialBackgroundImage

    Swift

    var tutorialBackgroundImage: UnsafeMutablePointer<Int32>? { get set }

  • Background Color of the main actions - defaults to rgb(0,37,68)

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor* mainButtonColor

    Swift

    var mainButtonColor: UnsafeMutablePointer<Int32>! { get set }

  • Tint color of the viewfinder - defaults to rgb(61,118,197)

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor* snapViewFinderTintColor

    Swift

    var snapViewFinderTintColor: UnsafeMutablePointer<Int32>! { get set }

  • Font of the main actions - defaults to system font 14

    Declaration

    Objective-C

    @property (nonatomic, strong) UIFont* mainButtonFont

    Swift

    var mainButtonFont: UnsafeMutablePointer<Int32>! { get set }

  • Image to be used for the manual snap button (only the centered icon - the button background color will be mainButtonColor) - defaults to the snap_icon provided with the SDK

    Declaration

    Objective-C

    @property (nonatomic, strong) UIImage* snapButtonImage

    Swift

    var snapButtonImage: UnsafeMutablePointer<Int32>! { get set }

  • Title to be used for the manual snap button (show below the snapButtonImage) - defaults to localize key Snapscreen_Snap_Button_Title

    Declaration

    Objective-C

    @property (nonatomic, strong, readwrite, nullable) NSString *snapButtonTitle;

    Swift

    var snapButtonTitle: UnsafeMutablePointer<Int32>? { get set }

  • Font to be used for the title of the manual snap button (show below the snapButtonImage) - defaults to system font 14

    Declaration

    Objective-C

    @property (nonatomic, strong) UIFont* snapButtonTitleFont

    Swift

    var snapButtonTitleFont: UnsafeMutablePointer<Int32>! { get set }

  • Text color of the main action buttons - defaults to white

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor* mainButtonTextColor

    Swift

    var mainButtonTextColor: UnsafeMutablePointer<Int32>! { get set }

  • Text color for the tutorial text - defaults to black

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor* tutorialTextColor

    Swift

    var tutorialTextColor: UnsafeMutablePointer<Int32>! { get set }

  • Font for the tutorial text - defaults to system font 14

    Declaration

    Objective-C

    @property (nonatomic, strong) UIFont* tutorialFont

    Swift

    var tutorialFont: UnsafeMutablePointer<Int32>! { get set }

  • AttributedString for the sharing introduction hint - displayed briefly on the trimming UI before switching to large sponsor image

    Declaration

    Objective-C

    @property (nonatomic, strong, readwrite, nullable)
    NSAttributedString *sharingIntroductionHint;

    Swift

    var sharingIntroductionHint: UnsafeMutablePointer<Int32>? { get set }

  • Image for the sharing introduction hint - displayed briefly on the trimming UI before switching to large sponsor image

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) UIImage* sharingIntroductionHintImage

    Swift

    var sharingIntroductionHintImage: UnsafeMutablePointer<Int32>? { get set }

  • Maximum Height constraint that is applied to the large sponsor image on the snap screen - defaults to -1 which means that the full image height is used

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    CGFloat maximumSponsorImageHeight;

    Swift

    var maximumSponsorImageHeight: Int32 { get set }

  • Maximum Height constraint that is applied to the large sponsor image on the tutorial screen - defaults to -1 which means that the full image height is used

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    CGFloat maximumTutorialSponsorImageHeight;

    Swift

    var maximumTutorialSponsorImageHeight: Int32 { get set }

  • Maximum Height constraint that is applied to the small sponsor image on the trimming page - defaults to -1 which means that the full image height is used

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    CGFloat maximumSmallSponsorImageHeight;

    Swift

    var maximumSmallSponsorImageHeight: Int32 { get set }

  • Perform automatic snapping. Defaults to true

    Declaration

    Objective-C

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

    Swift

    var automaticSnap: Int32 { 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: Int32 { 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: Int32 { get set }

  • Perform quadrangle detection and highlighting. Defaults to YES

    Declaration

    Objective-C

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

    Swift

    var quadrangleDetection: Int32 { get set }