Skip to main content
Version: 3.1.0

Settings

IReplayExportMimeTypes​

Implementation.

import type { IReplayExportMimeTypes } from '@picsart/web-replay-sdk';
ValuesDescription
video/mp4This will be used for suggested export settings for the video mime type
application/pdfThis will be used for suggested export settings for the pdf

IReplayExportSettings​

Implementation.

import type { IReplayExportSettings } from '@picsart/web-replay-sdk';

interface IReplayExportSettings {
'video/mp4': {
fps: number;
resolution: string;
};
'application/pdf': {
dpi: number;
colorMode: 'RGB' | 'CMYK';
unitOfMeasurement: 'PIXEL' | 'CENTIMETER' | 'INCH';
};
}

video/mp4​

PropertyTypeRequiredDescription
fpsnumbernoThe suggested fps value
resolutionstringnoThe suggested resolution for the exported video

application/pdf​

PropertyTypeRequiredDescription
dpinumbernoThe suggested dpi for the pdf
colorMode'RGB' | 'CMYK'noThe color space to be used for generating the pdf
unitOfMeasurement'PIXEL' | 'CENTIMETER' | 'INCH'noThe measurement unit to be used for generating the pdf

IReplayAssetSize​

Web and KMP implementation.

An array that has length for and consists of number. Represents mostly sizing correspondingly (top, right, bottom, left)

IReplayExperienceSettings​

Web and KMP implementation.

type mode = 'default' | 'presentation' | 'print' | 'video';

The experience mode can be one of 4 options:

  • default: A flexible editing and previewing experience designed for freestyle content creation. Build and display whatever you envision - from documents and designs to any creative work. Perfect for open-ended projects where you want complete creative freedom.
  • presentation: A slide-focused editing and previewing experience built for sequential storytelling. Create flowing presentations with smooth transitions between screens. Ideal for structured content that guides viewers through a step-by-step narrative.
  • print: A print-optimized editing and previewing experience designed for physical output. Create high-quality printable materials with precise control over margins, bleeds, and color modes.
  • video: A video-focused editing and previewing experience built for motion content. Create dynamic video projects with timeline-based editing and frame-by-frame control. Perfect for animations, video compositions, and other time-based media.

IReplayAssetSettings​

Implementation.

import type { IReplayExportMimeTypes } from '@picsart/web-replay-sdk';

interface IReplayAssetSettings {
margins: {
size: IReplayAssetSize;
};
bleed: {
size: IReplayAssetSize;
};
}
PropertyTypeRequiredDescription
margins.sizeIReplayAssetSizenoPrinting margin sizes
bleed.sizeIReplayAssetSizenoPrinting bleed sizes

IReplayExperienceSettings​

PropertyTypeRequiredDescription
modeIReplayExperienceModenoThe mode that determines how content is displayed

Implementation.

import type { IReplayExperienceSettings } from '@picsart/web-replay-sdk';

IReplaySettings​

Implementation.

import type { IReplaySettings } from '@picsart/web-replay-sdk';
PropertyTypeRequiredDescription
assetsIReplayAssetSettingsnoAssets to be used for exporting
exportsIReplayExportSettingsnoSuggested export settings per mime type
experienceIReplayExperienceSettingsnoSuggested experience settings