Skip to main content
Language:

Configure Border Frames

VideoEditor SDK supports configuring the frame tool allowing flexible adaptation to different needs and use cases. For a detailed explanation of how to configure different editor views, refer to this guide.

actions#

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

File:
import 'package:catalog/models/code_example.dart';
import 'package:imgly_sdk/imgly_sdk.dart';
import 'package:video_editor_sdk/video_editor_sdk.dart';


class VideoFramesConfigurationExample extends CodeExample {
  @override
  void invoke() async {
    // Add a video from the assets directory.
    final video = Video("assets/Skater.mp4");


    // Create [FrameOptions] to customize the frame tool.
    final frameOptions = FrameOptions(
        // By default all actions are enabled in the frame tool.
        // For this example only two of them are enabled.
        actions: [FrameAction.opacity, FrameAction.replace]
        );


    // Create a [Configuration] instance.
    final configuration = Configuration(frame: frameOptions);


    try {
      // Open the video editor and handle the export as well as any occurring errors.
      final result =
          await VESDK.openEditor(video, configuration: configuration);


      if (result != null) {
        // The user exported a new video successfully and the newly generated video is located at `result.video`.
        print(result.video);
      } else {
        // The user tapped on the cancel button within the editor.
        return;
      }
    } catch (error) {
      // There was an error generating the video.
      print(error);
    }
  }
}