Configuration
@objcMembers
@objc(PESDKConfiguration)
open class Configuration : NSObject
An Configuration defines behaviour and look of all view controllers
provided by the PhotoEditorSDK. It uses the builder pattern to create an
immutable object via a closure. To configure the different editors and
viewControllers contained in the SDK, edit their options in the corresponding
configure*ViewController
method of the ConfigurationBuilder
.
-
The overall theme used to configure colors of the UI elements. Defaults to
Theme.dark
.Declaration
Swift
public let theme: Theme
-
This closure is called after the theme was applied via
UIAppearance
proxies during the initialization of aCameraViewController
or aMediaEditViewController
. It is intended to run custom calls toUIAppearance
proxies. The immutable active theme is passed to this closure.Declaration
Swift
public let appearanceProxyConfigurationClosure: ((Theme) -> Void)?
-
The asset catalog which configures all assets that are available for editing tasks, such as stickers, frames, effects, overlays, fonts, and text designs. Defaults to
AssetCatalog.shared
.Declaration
Swift
public let assetCatalog: AssetCatalog
-
Options for the
CameraViewController
.Declaration
Swift
public var cameraViewControllerOptions: CameraViewControllerOptions { get }
-
Options for the
FilterToolController
.Declaration
Swift
public var filterToolControllerOptions: FilterToolControllerOptions { get }
-
Options for the
OverlayToolController
.Declaration
Swift
public var overlayToolControllerOptions: OverlayToolControllerOptions { get }
-
Options for the
StickerToolController
.Declaration
Swift
public var stickerToolControllerOptions: StickerToolControllerOptions { get }
-
Options for the
StickerOptionsToolController
.Declaration
Swift
public var stickerOptionsToolControllerOptions: StickerOptionsToolControllerOptions { get }
-
Options for the
StickerColorToolController
.Declaration
Swift
public var stickerColorToolControllerOptions: ColorToolControllerOptions { get }
-
Options for the
TransformToolController
.Declaration
Swift
public var transformToolControllerOptions: TransformToolControllerOptions { get }
-
Options for the
FocusToolController
.Declaration
Swift
public var focusToolControllerOptions: FocusToolControllerOptions { get }
-
Options for the
TextToolController
.Declaration
Swift
public var textToolControllerOptions: TextToolControllerOptions { get }
-
Options for the
TextOptionsToolController
.Declaration
Swift
public var textOptionsToolControllerOptions: TextOptionsToolControllerOptions { get }
-
Options for the
TextFontToolController
.Declaration
Swift
public var textFontToolControllerOptions: TextFontToolControllerOptions { get }
-
Options for the
TextColorToolController
.Declaration
Swift
public var textColorToolControllerOptions: TextColorToolControllerOptions { get }
-
Options for the
AdjustToolController
.Declaration
Swift
public var adjustToolControllerOptions: AdjustToolControllerOptions { get }
-
Options for the
BrushToolController
.Declaration
Swift
public var brushToolControllerOptions: BrushToolControllerOptions { get }
-
Options for the
BrushColorToolController
.Declaration
Swift
public var brushColorToolControllerOptions: BrushColorToolControllerOptions { get }
-
Options for the
FrameToolController
.Declaration
Swift
public var frameToolControllerOptions: FrameToolControllerOptions { get }
-
Options for the
FrameOptionsToolController
.Declaration
Swift
public var frameOptionsToolControllerOptions: FrameOptionsToolControllerOptions { get }
-
Options for the
TextDesignToolController
.Declaration
Swift
public var textDesignToolControllerOptions: TextDesignToolControllerOptions { get }
-
Options for the
TextDesignOptionsToolController
.Declaration
Swift
public var textDesignOptionsToolControllerOptions: TextDesignOptionsToolControllerOptions { get }
-
Global snapping options for all sprites, e.g., stickers, texts, and text designs.
Declaration
Swift
public var snappingOptions: SnappingOptions { get }
-
Global watermark options.
Declaration
Swift
public var watermarkOptions: WatermarkOptions { get }
-
Generic method that returns the options of a given type, if available.
Declaration
Swift
public func getOptions<T>() -> T? where T : AnyObject
Return Value
The options for the given type.
-
Creates a newly allocated instance of
Configuration
using the given builder.Declaration
Swift
public init(builder: (ConfigurationBuilder) -> Void)
Parameters
builder
An instance of
ConfigurationBuilder
. -
Options for the
PhotoEditViewController
.Declaration
Swift
var photoEditViewControllerOptions: PhotoEditViewControllerOptions { get }
-
Options for the
VideoEditViewController
.Declaration
Swift
var videoEditViewControllerOptions: VideoEditViewControllerOptions { get }
-
Options for the
TrimToolController
.Declaration
Swift
var trimToolControllerOptions: TrimToolControllerOptions { get }
-
Options for the
CompositionToolController
.Declaration
Swift
var compositionToolControllerOptions: CompositionToolControllerOptions { get }
-
Options for the
ClipTrimToolController
.Declaration
Swift
var clipTrimToolControllerOptions: ClipTrimToolControllerOptions { get }
-
Options for the
VideoClipToolController
.Declaration
Swift
var videoClipToolControllerOptions: VideoClipToolControllerOptions { get }
-
Options for the
AudioClipToolController
.Declaration
Swift
var audioClipToolControllerOptions: AudioClipToolControllerOptions { get }
-
Options for the
AudioToolController
.Declaration
Swift
var audioToolControllerOptions: AudioToolControllerOptions { get }