Serialization of Video Segments

VideoEditor SDK for Flutter supports serialization and deserialization of the individual video segments of a video composition, allowing your users to save and revise their work at any time.

Enable Serialization#

To use the serialization feature for video segments, you first need to enable this option within the configuration.

Process Serialization data#

Once the editor has exported the video successfully, the VideoEditorResult also contains the segments as well as the videoSize that you can further process. The segments represent all of the composition parts. In order to reuse the segments you need to save them in a persistent location. The videoSize embodies the size of the initial video and is needed to restore the state.

Once processed, you need to release the VideoEditorResult using the VideoEditorResult.release() function. This will remove the temporary resources.

The next section explains how to restore the editor state by deserializing these settings.


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

class VideoSegmentsSerializationExample extends CodeExample {
  @override
  void invoke() async {
    try {
      // Create [ExportOptions] to configure the video export.
      final exportOptions = ExportOptions(video: VideoOptions(segments: true));

      // Create a [Configuration] instance.
      final configuration = Configuration(export: exportOptions);

      // Add a video from the assets directory.
      final video = Video("assets/Skater.mp4");

      // 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`
        // and the serialization is located at `result.serialization`.
        print(result.toJson());

        // Once you have processed the serialized segments, you need to release the
        // result.
        result.release();
      } else {
        // The user tapped on the cancel button within the editor.
        return;
      }
    } catch (error) {
      // There was an error generating the video.
      print(error);
    }
    // highlight-events
  }
}