Skip to content

voplica.types.file.convert

The protobuf package voplica.types.file.convert: 0 services, 3 messages and 2 enums, defined in voplica/types/file/convert/file_convert.proto.

Field Number Type Label Description
required_params 1 ConvertParamType repeated
supported_source_file_types 2 voplica.types.base.FileType repeated
auto_applicable_for_file_types 3 voplica.types.base.FileType repeated Marks the flow as auto-triggered for any file types - regardless if the user used this flow or not. Usually this should be empty except for default convert flows (i.e. <type>_DEFAULT).
auto_proxied_params 4 ConvertParamType repeated If this flow was triggered not explicitly by the user, but by auto-apply logic, then this list specifies what convert parameters should used from those provided by the user. Usually this should be equal to required_params (mostly empty for default flows)
default_presentation_type 5 voplica.types.base.ContentPresentationType If presentation type is not specified explicitly then this one will be used for the converted file
user_trigger_allowed 6 bool
optional_params 7 ConvertParamType repeated
Field Number Type Label Description
param_key 1 ConvertParamType
param_value 2 voplica.types.base.ParamValue
Field Number Type Label Description
name 1 string
data_type 2 voplica.types.base.ParamDataType

This type is used for conversion services to determine how to convert files

Name Number Description
CONVERT_FLOW_TYPE_UNSPECIFIED 0
OBJECT_DEFAULT 1
IMAGE_DEFAULT 1000 Default flow for images. It will create multiple resolutions in jpeg and webp formats for the same image preserving aspect ratio.
IMAGE_PROFILE_AVATAR 1001 User / Character avatar image. Creates multiple jpeg and webp square images. X - from where to crop on X axis Y - from where to crop on Y axis SIDE_LENGTH - length of square sides (used both for width and height)
IMAGE_PROFILE_BANNER 1002 Profile banner image. Creates multiple jpeg and webp with wide horizontal images of 4/1 aspect ratios. X - from where to crop on X axis Y - from where to crop on Y axis WIDTH - width length to crop HEIGHT - height length to crop
IMAGE_VERTICAL_VIEW 1003 (unused for now) Vertical images. Creates multiple jpeg and webp vertical images of 4/5 and 9/16 aspect ratios. X - from where to crop on X axis Y - from where to crop on Y axis WIDTH - width length to crop HEIGHT - height length to crop * Video convert flows
VIDEO_DEFAULT 2000 Uses VIDEO_STREAM_ONLY to retrieve necessary video streams. Tries to get audio from the provided audio file OR fallbacks to finding the first audio stream from the video file. If audio is found
VIDEO_STREAM_EXTRACTION 2001 Extracts the first video stream from the video, converts video stream with necessary codecs, discards everything else.
VIDEO_DEFAULT_THUMBNAIL_EXTRACTION 2002 Extracts the first video stream from the video, converts video stream with necessary codecs, discards everything else.
VIDEO_CONCAT 2003
VIDEO_TRIM_EXACT 2004 Trims the source down to the exact target duration (VIDEO_TRIM_DURATION_MS), frame-accurate re-encode when needed. If the target meets or exceeds the source duration, the source passes through unchanged - no padding is performed. Trim-only by design: callers (e.g. the long-form video director) are expected to guarantee target <= source, for example by rounding requested clip frames up rather than down.
VIDEO_EXTRACT_LAST_FRAME 2005
VIDEO_MIX_VOICE_OVER_BED 2006 Mixes a voice/speech track over a video’s own audio bed (sidechain duck + mix + loudnorm) and remuxes the result onto the video stream. Inputs: source_file_ids[0] = the video, source_file_ids[1] = the voice audio. Output is a video with the mixed track; the video stream is copied untouched. Internal-only.
AUDIO_DEFAULT 3000 Audio convert flows
AUDIO_STREAM_EXTRACTION 3001 Extracts audio stream from audio or video and converts it using proper codecs
AUDIO_MIX_VOICE_OVER_BED 3002
AUDIO_SEGMENT_CONCAT 3003
TEXT_DEFAULT 4000 Text convert flows
MODEL_3D_DEFAULT 5000 3D model convert flows
MODEL_GEN_ASSET_ATTACH 6000 Simply attaches model file to the Asset of the File Upload process
MODEL_GEN_IMAGE_BASE_DEFAULT 7000 LoRa image model convert flows
VECTOR_GRAPHIC_DEFAULT 8000 Default flow for vector graphics. Preserves the original vector file and creates rasterized preview images in multiple resolutions (png, jpeg and webp). Supports SVG, EPS, WMF, EMF, CDR, AI and PDF as source formats.
VECTOR_GRAPHIC_RASTERIZE 8001 Rasterizes a vector graphic into multiple image resolutions (jpeg and webp). Optional VECTOR_GRAPHIC_DPI parameter controls rasterization density (defaults to service-defined value if not provided).

All supported parameters that may be used in convert commands

Name Number Description
CONVERT_PARAM_TYPE_UNSPECIFIED 0
X 1
Y 2
WIDTH 3
HEIGHT 4
SIDE_LENGTH 5
THREADS 100
BITRATE 101
CHANNELS_COUNT 102
AUDIO_SAMPLE_RATE 201
AUDIO_MI 202
AUDIO_MLRA 203
AUDIO_MTP 204
AUDIO_MTH 205
AUDIO_OFFSET 206
AUDIO_INPUT 207
AUDIO_APPLY_DOUBLE_PASS_LOUDNORM 208
AUDIO_SEGMENT_GAP_MS 209 Silence duration (ms) inserted between concatenated segments for AUDIO_SEGMENT_CONCAT. 0 = no gap (immediate concatenation).
AUDIO_DUCKING_LEVEL_DB 210 Sidechain ducking depth (dB) applied to the background bed under the voice-over track for AUDIO_MIX_VOICE_OVER_BED. 0 = no ducking.
VIDEO_SAVE_EXTERNAL_AUDIO 301
VIDEO_FPS 302
VIDEO_GOP 303
VIDEO_INPUT 304
VIDEO_TRIM_DURATION_MS 305 Exact target duration (ms) for VIDEO_TRIM_EXACT. Trim-only: if the target meets or exceeds the source duration, the source passes through unchanged (no padding). Callers are expected to guarantee target <= source duration.
MODEL_GEN_FAMILY_TYPE_ID 401
MODEL_GEN_TYPE_ID 402
MODEL_GEN_FILE_STRUCTURE_ID 403
MODEL_GEN_DTYPE_ID 404
MODEL_GEN_QUANTIZATION_TYPE_ID 405
MODEL_GEN_ROLE_ID 406 voplica.types.ai.common.ModelFileRole NUMBER. Optional on MODEL_GEN_ASSET_ATTACH: absent == MODEL_FILE_ROLE_UNSPECIFIED.
MODEL_GEN_COMPONENT_NAME 407 Diffusers slot name (“transformer”, “vae”, “text_encoder”, “text_encoder_2”, …). Optional on MODEL_GEN_ASSET_ATTACH: absent == “”.
VECTOR_GRAPHIC_DPI 501 DPI for rasterizing vector graphics (e.g. 72, 150, 300)