Skip to main content
Version: 3.1.0

Settings

configureReplayExports

You can configure the export suggested configuration per mime type.

Implementation.

import { configureReplayExports } from '@picsart/web-replay-sdk/settings';
function configureReplayExports(replay: IReplay, exports: Partial<IReplayExportSettings>): IReplay
ParametersTypeRequiredDescription
replayIReplayyesThe replay memory object.
exportsPartial<IReplayExportSettings>yesA partial configuration on replay settings

Returns a IReplay

configureReplayAssets

You can configure the editor's different assets configurations and visual appearance(bleeds, margins)

Implementation.

import { configureReplayAssets } from '@picsart/web-replay-sdk/settings';
function configureReplayAssets(replay: IReplay, assets: Partial<IReplayAssetSettings>): IReplay 
ParametersTypeRequiredDescription
replayIReplayyesThe replay memory object.
assetsPartial<IReplayExportSettings>yesA partial configuration on replay settings

Returns a IReplay

configureReplayExperience

You can configure the experience mode for the replay editor, controlling how content is displayed (default, presentation).

Implementation.

import { configureReplayExperience } from '@picsart/web-replay-sdk/settings';
function configureReplayExperiance(replay: IReplay, canvas: Partial<IReplayExperienceSettings>): IReplay
ParametersTypeRequiredDescription
replayIReplayyesThe replay memory object.
experienceIReplayExperienceSettingsyesThe replay experience configuration

Returns a IReplaySettings

getReplaySettings

Provides replay's current settings.

Implementation.

import { getReplaySettings } from '@picsart/web-replay-sdk/settings';
function getReplaySettings(replay: IReplay): IReplaySettings
ParametersTypeRequiredDescription
replayIReplayyesThe replay memory object.

Returns a IReplaySettings