Configure Text Design

View on GitHub

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

`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.

`colorPalette`#

The default color palette can be configured passing a ColorPalette object to the colorPalette property containing an array of colors you want to make available.

`allowedTextDesignOverlayActions`#

Configuring the TextDesignOptionsToolController allows changing the way users can interact with the text designs that have been placed on a video. The actions users can perform are configured via the allowedTextDesignOverlayActions property. In our example, we remove the options to undo (.undo) and redo (.redo) changes.


import UIKit
import VideoEditorSDK

class VideoTextDesignConfigurationSwift: 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 `TextDesignToolController` that lets the user
      // add text designs to the video.
      builder.configureTextDesignToolController { options in
        // 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 editor provides a `ColorPalette` with a lot of colors.
        // For this example this will be replaced with a `ColorPalette`
        // with only a few colors enabled.
        options.colorPalette = ColorPalette(colors: [
          Color(color: UIColor.white, colorName: "White"),
          Color(color: UIColor.black, colorName: "Black")
        ])
      }

      // Configure the `TextDesignOptionsToolController` that lets the user
      // change text designs that have been placed on top of the video.
      builder.configureTextDesignOptionsToolController { options in
        // By default the editor has all available overlay actions for this tool
        // enabled. For this example `TextDesignOverlayAction.undo` and `TextDesignOverlayAction.redo`
        // are removed.
        options.allowedTextDesignOverlayActions = [.add, .bringToFront, .delete, .invert]
      }
    }

    // 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 Text Design

emojisEnabled#

colorPalette#

allowedTextDesignOverlayActions#

`emojisEnabled`#

`colorPalette`#

`allowedTextDesignOverlayActions`#