Configure Fonts

View on GitHub

VideoEditor SDK supports several configuration options for the TextToolController allowing flexible adaptation to different needs and use cases. For a detailed explanation of how to configure different editor views, refer to this guide.

`defaultTextAlignment`#

By default, the text alignment is set to NSTextAlignment.center. In our example, we set the text orientation to NSTextAlignment.left.

`emojisEnabled`#

By default, the editor allows adding emojis as text input. It is important to note that since emojis are not cross-platform compatible using the serialization feature to share edits across different platforms will result in emojis being rendered with the system's local set of emojis and therefore will appear differently. For this example emoji input is disabled to ensure a consistent cross-platform experience.

`minimumTextSize`#

The default text size is 20pt, for this example, we reduce it to 17pt.

`allowedTextActions`#

Configuring the TextOptionsToolController allows changing how users can interact with a given text. The actions users can perform are configured via the allowedTextActions property. In our example, only allow changing the duration, font, and color of the text. For a complete list of available text actions consult the API docs

`textFontActionSelectedClosure`#

Configuring the TextFontToolController allows passing a closure that is executed every time the user selects a font. This could be used, for instance, to gather analytics on font usage.

`availableColors`#

Configuring the TextColorToolController allows changing which colors users can use to customize stickers. Here, we assign an array of Color objects containing the UIColors we want to make available.

`availableBackgroundTextColors`#

The editor provides a variety of different colors to customize the background color of the text. In this example, only a small selection of colors is shown by default e.g. based on the favorite colors of the user.


import UIKit
import VideoEditorSDK

class VideoTextConfigurationSwift: Example, VideoEditViewControllerDelegate {
  override func invokeExample() {
    // Create a `Video` from a URL to a video in the app bundle.
    let video = Video(url: Bundle.main.url(forResource: "Skater", withExtension: "mp4")!)

    // Create a `Configuration` object.
    let configuration = Configuration { builder in
      // Configure the `TextToolController` which lets the user
      // add text to the video.
      builder.configureTextToolController { options in
        // By default the text alignment is set to `NSTextAlignment.center`.
        // In this example, the default text orientation is set to `NSTextAlignment.left`.
        options.defaultTextAlignment = .left

        // By default the editor allows to add emojis as text input.
        // Since emojis are not cross-platform compatible, using the serialization
        // feature to share edits across different platforms will result in emojis
        // being rendered with the system's local set of emojis and therefore will
        // appear differently.
        // For this example emoji input is disabled to ensure a consistent cross-platform experience.
        options.emojisEnabled = false

        // By default the minimum text size is set to 20pt.
        // For this example the minimum size is reduced.
        options.minimumTextSize = 17.0
      }

      // Configure the `TextOptionsToolController` which lets the user
      // customize a selected text when added to the canvas.
      builder.configureTextOptionsToolController { options in
        // By default the editor enables all available text actions.
        // For this example only a small selection of text actions
        // should be allowed.
        options.allowedTextActions = [.duration, .selectFont, .selectColor]
      }

      // Configure the `TextFontToolController` which lets the user
      // change the font of the text.
      builder.configureTextFontToolController { options in
        // This closure is executed every time the user selects a font.
        options.textFontActionSelectedClosure = { fontName in
          print("Font has been selected with name:", fontName)
        }
      }

      // Configure the `TextColorToolController` which lets the user
      // change the color of the text.
      builder.configureTextColorToolController { options in
        // By default the editor provides a variety of different
        // colors to customize the color of the text.
        // For this example only a small selection of colors is shown by default
        // e.g. based on favorite colors of the user.
        options.availableColors = [
          Color(color: UIColor.white, colorName: "White"),
          Color(color: UIColor.black, colorName: "Black")
        ]

        // By default the editor provides a variety of different
        // colors to customize the background color of the text.
        // For this example only a small selection of colors is shown by default
        // e.g. based on favorite colors of the user.
        options.availableBackgroundTextColors = [
          Color(color: UIColor.red, colorName: "Red"),
          Color(color: UIColor.green, colorName: "Green"),
          Color(color: UIColor.yellow, colorName: "Yellow")
        ]
      }
    }

    // Create and present the video editor. Make this class the delegate of it to handle export and cancelation.
    let videoEditViewController = VideoEditViewController(videoAsset: video, configuration: configuration)
    videoEditViewController.delegate = self
    videoEditViewController.modalPresentationStyle = .fullScreen
    presentingViewController?.present(videoEditViewController, animated: true, completion: nil)
  }

  // MARK: - VideoEditViewControllerDelegate

  func videoEditViewControllerShouldStart(_ videoEditViewController: VideoEditViewController, task: VideoEditorTask) -> Bool {
    // Implementing this method is optional. You can perform additional validation and interrupt the process by returning `false`.
    true
  }

  func videoEditViewControllerDidFinish(_ videoEditViewController: VideoEditViewController, result: VideoEditorResult) {
    // The user exported a new video successfully and the newly generated video is located at `result.output.url`. Dismissing the editor.
    presentingViewController?.dismiss(animated: true, completion: nil)
  }

  func videoEditViewControllerDidFail(_ videoEditViewController: VideoEditViewController, error: VideoEditorError) {
    // There was an error generating the video.
    print(error.localizedDescription)
    // Dismissing the editor.
    presentingViewController?.dismiss(animated: true, completion: nil)
  }

  func videoEditViewControllerDidCancel(_ videoEditViewController: VideoEditViewController) {
    // The user tapped on the cancel button within the editor. Dismissing the editor.
    presentingViewController?.dismiss(animated: true, completion: nil)
  }
}

Configure Fonts

defaultTextAlignment#

emojisEnabled#

minimumTextSize#

allowedTextActions#

textFontActionSelectedClosure#

availableColors#