Configure Border Frames

View on GitHub

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

`rotationEnabled`#

By default, the editor does not allow to rotate the video in the frame tool by using the rotation gestures. For this example, this behavior is enabled.

`allowedFrameActions`#

Configuring the FrameOptionsToolController allows changing how users can interact with a given frame. The actions users can perform are configured via the allowedFrameActions property. In our example, we remove the option to change the frame width (.width) and only allow replacing it and changing its opacity.


import UIKit
import VideoEditorSDK

class VideoFramesConfigurationSwift: 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 `FrameToolController` which lets the user
      // select a frame.
      builder.configureFrameToolController { options in
        // By default the editor does not allow to rotate the image in
        // the frame tool by using the roation gestures. For this example,
        // this behavior is enabled.
        options.rotationEnabled = true
      }

      // Configure the `FrameOptionsToolController` which allows customization
      // of the selected frame.
      builder.configureFrameOptionsToolController { options in
        // By default the editor enables all available frame actions.
        // For this example only a small selection is enabled.
        options.allowedFrameActions = [.replace, .opacity]
      }
    }

    // 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 Border Frames

rotationEnabled#

allowedFrameActions#

`rotationEnabled`#

`allowedFrameActions`#