From App Bundle

VideoEditor SDK supports adding custom frames from the app bundle.

Adding Frames#

Custom frames can be added by specifying them in the configuration.frame.items array. Each frame takes a unique identifier, a name, a relativeScale, an optional thumbnailURI as well as an optional layoutMode.

Image Groups#

To add the images for each frame tile, you can specify them inside the imageGroups property. Each frame consists of four groups corresponding to each side of the frame. In our example, we opt for the "horizontal inside" mode of arranging image tiles providing only a middle image for the left and right parts of the frame and a start, middle and end image for the top and bottom parts. Refer to the guide on frames for an in-depth explanation.

Image Modes#

By default, the midMode is set to FrameTileMode.REPEAT which repeats the middle image to fill out the entire space. For this example, it is set to FrameTileMode.STRETCH for all image groups to keep the correct pattern. In this mode, the middle image is stretched to fill out the entire space.


import {
  Configuration,
  FrameLayoutMode,
  FrameTileMode,
  VESDK,
} from "react-native-videoeditorsdk";

export const videoFramesAppBundleExample = async (): Promise<void> => {
  try {
    // Add a video from the assets directory.
    const video = require("../../../../../assets/vesdk/Skater.mp4");
    
    // Create a `Configuration` object.
    const configuration: Configuration = {
      frame: {
        items: [
          {
            identifier: "custom_frame",
            name: "Custom",
            thumbnailURI: require("../../../../../assets/frames/imgly_frame_lowpoly_thumbnail.png"),
            layoutMode: FrameLayoutMode.HORIZONTAL_INSIDE,
            relativeScale: 0.1,
            imageGroups: {
              top: {
                midURI: require("../../../../../assets/frames/imgly_frame_lowpoly_top.png"),
                startURI: require("../../../../../assets/frames/imgly_frame_lowpoly_top_left.png"),
                endURI: require("../../../../../assets/frames/imgly_frame_lowpoly_top_right.png"),
                midMode: FrameTileMode.STRETCH,
              },
              left: {
                midURI: require("../../../../../assets/frames/imgly_frame_lowpoly_left.png"),
                midMode: FrameTileMode.STRETCH,
              },
              right: {
                midURI: require("../../../../../assets/frames/imgly_frame_lowpoly_right.png"),
                midMode: FrameTileMode.STRETCH,
              },
              bottom: {
                midURI: require("../../../../../assets/frames/imgly_frame_lowpoly_bottom.png"),
                startURI: require("../../../../../assets/frames/imgly_frame_lowpoly_bottom_left.png"),
                endURI: require("../../../../../assets/frames/imgly_frame_lowpoly_bottom_right.png"),
                midMode: FrameTileMode.STRETCH,
              },
            },
          },
        ],
      },
    };

    // Open the video editor and handle the export as well as any occuring errors.
    const result = await VESDK.openEditor(video, configuration);

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