PSPDFGalleryConfiguration


@interface PSPDFGalleryConfiguration
    : PSPDFBaseConfiguration <PSPDFGalleryConfigurationBuilder *>

A PSPDFGalleryConfiguration defines the behavior of a PSPDFGalleryViewController.

  • The max. number of concurrent downloads. Defaults to 0, which indicates that the number of downloads will be dynamically decided depending on the connection.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSUInteger maximumConcurrentDownloads;

    Swift

    var maximumConcurrentDownloads: UInt { get }
  • The max. number of images after the currently visible one that should be prefetched. Defaults to 3. To disable prefetching, set this to zero.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSUInteger maximumPrefetchDownloads;

    Swift

    var maximumPrefetchDownloads: UInt { get }
  • Controls if the user can switch between the fullscreen mode and embedded mode by double-tapping or panning. Defaults to YES. - note: This only affects user interaction. If you call setFullscreen:animated: programmatically, the mode will still be set accordingly.

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL displayModeUserInteractionEnabled;

    Swift

    var displayModeUserInteractionEnabled: Bool { get }
  • The threshold in points after which the fullscreen mode is exited after a pan. Defaults to 80pt.

    Declaration

    Objective-C

    @property (readonly, nonatomic) CGFloat fullscreenDismissPanThreshold;

    Swift

    var fullscreenDismissPanThreshold: CGFloat { get }
  • Set this to YES if zooming should be enabled in fullscreen mode. Defaults to YES.

    Declaration

    Objective-C

    @property (readonly, getter=isFullscreenZoomEnabled, nonatomic)
        BOOL fullscreenZoomEnabled;

    Swift

    var isFullscreenZoomEnabled: Bool { get }
  • The maximum zoom scale that you want to allow. Only meaningful if fullscreenZoomEnabled is YES Defaults to 20.0.

    Declaration

    Objective-C

    @property (readonly, nonatomic) CGFloat maximumFullscreenZoomScale;

    Swift

    var maximumFullscreenZoomScale: CGFloat { get }
  • The minimum zoom scale that you want to allow. Only meaningful if fullscreenZoomEnabled is YES. Defaults to 1.0.

    Declaration

    Objective-C

    @property (readonly, nonatomic) CGFloat minimumFullscreenZoomScale;

    Swift

    var minimumFullscreenZoomScale: CGFloat { get }
  • Controls if the gallery should loop infinitely, that is if the user can keep scrolling forever and the content will repeat itself. Defaults to YES. Ignored if there’s only one item set.

    Declaration

    Objective-C

    @property (readonly, getter=isLoopEnabled, nonatomic) BOOL loopEnabled;

    Swift

    var isLoopEnabled: Bool { get }
  • Setting this to YES will present a HUD whenever the user goes from the last image to the first one. Defaults to YES. - note: This property has no effect if loopEnabled is set to NO.

    Declaration

    Objective-C

    @property (readonly, getter=isLoopHUDEnabled, nonatomic) BOOL loopHUDEnabled;

    Swift

    var isLoopHUDEnabled: Bool { get }
  • Indicates whether a media player in the gallery should automatically switch to external playback mode while the external screen mode is active in order to play video content. Defaults to YES.

    Declaration

    Objective-C

    @property (readonly, nonatomic)
        BOOL usesExternalPlaybackWhileExternalScreenIsActive;

    Swift

    var usesExternalPlaybackWhileExternalScreenIsActive: Bool { get }
  • Indicates whether multiple galleries can play audio or video content simultaneously. Defaults to NO.

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL allowPlayingMultipleInstances;

    Swift

    var allowPlayingMultipleInstances: Bool { get }