Skip to content

IPC.md

Latest commit

 

History

History
182 lines (161 loc) · 11.9 KB

IPC.md

File metadata and controls

182 lines (161 loc) · 11.9 KB
Raw

🔌 IPC Channels & electronAPI

All channel names are centralized in src/shared/ipc-channels.ts.

📥 Requests (invoke from renderer)

Channel Arguments Returns
select-file filters? string | null
select-files filters? string[]
select-output — string | null
select-directory — string | null
get-media-info filePath, transcoderType MediaInfo
get-image-info filePath ImageExifData | null
get-image-preview filePath string | null (data URL)
get-image-file-info filePath ImageFileInfo | null
get-video-preview filePath string | null (data URL)
get-capabilities — EncoderCapabilities | null
convert-file input, output, options, transcoderType void
cancel-conversion — void
pause-conversion — void
resume-conversion — void
queue-add input, output, options, transcoder string (job id)
queue-remove id void
queue-list — QueueJob[]
queue-get-state — { paused, concurrency }
queue-cancel-all — void
queue-clear-completed — number (count removed)
queue-set-concurrency concurrency void
queue-set-when-done config void
queue-move-to id, toPosition boolean
queue-update-options id, options, output? boolean
queue-start — void
queue-pause — void
queue-resume — void
queue-export — number (count exported)
queue-import — number (count imported)
reveal-file filePath void
set-launch-at-login enabled void
player-open filePath number (generation token)
player-seek time number (generation token)
player-close — void
player-get-frame — PlayerFrame | null
extract-waveform filePath, duration WaveformData | null
extract-thumbnails filePath, duration ThumbnailStrip | null
check-for-updates — void
download-update — void
install-update installerPath void
cancel-download — void
open-release-notes url void

📤 Send-only (renderer to main)

Channel Payload
window-minimize —
window-maximize-toggle —
window-close —
window-confirm-close —
window-set-always-on-top boolean

📡 Events (main to renderer)

Channel Payload
window-maximized-changed boolean
window-close-requested —
conversion-progress { input, output, progress }
queue-added QueueJob
queue-removed string (job id)
queue-status-change QueueJob
queue-progress { job, progress }
queue-cancelled —
queue-moved { id, toPosition }
player-frame PlayerFrame
player-audio PlayerAudioChunk
player-error string
log-message LogEntry
update-available UpdateInfo
update-not-available —
update-progress UpdateProgress
update-downloaded string (installer path)
update-error string (error message)

🧩 window.electronAPI (contextBridge API)

The preload script exposes all IPC via window.electronAPI (typed in src/renderer/electron-api.d.ts):

Invocation methods

  • getPathForFile(file) -> string
  • selectFile(filters?) -> Promise<string | null>
  • selectFiles(filters?) -> Promise<string[]>
  • selectOutput() -> Promise<string | null>
  • selectDirectory() -> Promise<string | null>
  • getMediaInfo(filePath, transcoderType) -> Promise<MediaInfo>
  • getImageInfo(filePath) -> Promise<ImageExifData | null>
  • getImagePreview(filePath) -> Promise<string | null>
  • getImageFileInfo(filePath) -> Promise<ImageFileInfo | null>
  • getVideoPreview(filePath) -> Promise<string | null>
  • getCapabilities() -> Promise<EncoderCapabilities | null>
  • convertFile(input, output, options, transcoderType) -> Promise<void>
  • pauseConversion() -> Promise<void>
  • resumeConversion() -> Promise<void>
  • cancelConversion() -> Promise<void>
  • queueAdd(input, output, options, transcoder) -> Promise<string>
  • queueRemove(id) -> Promise<void>
  • queueList() -> Promise<QueueJob[]>
  • queueGetState() -> Promise<{ paused, concurrency }>
  • queueCancelAll() -> Promise<void>
  • queueClearCompleted() -> Promise<number>
  • queueSetConcurrency(concurrency) -> Promise<void>
  • queueSetWhenDone(config) -> Promise<void>
  • queueMoveTo(id, toPosition) -> Promise<boolean>
  • queueUpdateOptions(id, options, output?) -> Promise<boolean>
  • queueStart() -> Promise<void>
  • queuePause() -> Promise<void>
  • queueResume() -> Promise<void>
  • queueExport() -> Promise<number>
  • queueImport() -> Promise<number>
  • revealFile(filePath) -> Promise<void>
  • setLaunchAtLogin(enabled) -> void
  • playerOpen(filePath) -> Promise<number> (generation token)
  • playerSeek(time) -> Promise<number> (generation token)
  • playerClose() -> Promise<void>
  • playerGetFrame() -> Promise<PlayerFrame | null>
  • extractWaveform(filePath, duration) -> Promise<WaveformData | null>
  • extractThumbnails(filePath, duration) -> Promise<ThumbnailStrip | null>
  • windowMinimize() -> void
  • windowMaximizeToggle() -> void
  • windowClose() -> void
  • windowCloseConfirmed() -> void
  • windowSetAlwaysOnTop(flag) -> void
  • checkForUpdates() -> Promise<void>
  • downloadUpdate() -> Promise<void>
  • installUpdate(installerPath) -> Promise<void>
  • cancelDownload() -> Promise<void>
  • openReleaseNotes(url) -> Promise<void>

Event listeners (each returns a cleanup function)

  • onWindowCloseRequested(cb) -> () => void
  • onWindowMaximizedChange(cb) -> () => void
  • onConversionProgress(cb) -> () => void
  • onQueueAdded(cb) -> () => void
  • onQueueRemoved(cb) -> () => void
  • onQueueStatusChange(cb) -> () => void
  • onQueueProgress(cb) -> () => void
  • onQueueCancelled(cb) -> () => void
  • onQueueMoved(cb) -> () => void
  • onPlayerFrame(cb) -> () => void
  • onPlayerAudio(cb) -> () => void
  • onPlayerError(cb) -> () => void
  • onLogMessage(cb) -> () => void
  • onUpdateAvailable(cb) -> () => void
  • onUpdateNotAvailable(cb) -> () => void
  • onUpdateProgress(cb) -> () => void
  • onUpdateDownloaded(cb) -> () => void
  • onUpdateError(cb) -> () => void

📦 Remux & Demux reuse CONVERT_FILE

Remux and demux add no new IPC channels. Both features plan their FFmpeg invocations in the renderer (or CLI/MCP layer) and then submit them through the existing channels:

  • convert-file (CONVERT_FILE) for a single-shot job, and
  • queue-add (QUEUE_ADD) for batched or multi-target work — demux enqueues one job per extracted stream.

All stream-composition data rides inside the existing options: ConversionOptions payload, so the main process, the transcoder cores, progress events (CONVERSION_PROGRESS), and the queue's pause/resume/cancel plumbing are reused unchanged.

New ConversionOptions fields

Field Type Notes
map string[] Explicit -map specs for the primary input (index 0), e.g. ['0:v:0', '0:a:1']. Replaces FFmpeg's implicit best-stream selection.
additionalInputs RemuxInput[] Extra inputs appended after the primary, each with its own map specs, optional codec (-c:<kind>), optional disposition, optional syncOffsetSeconds (-itsoffset), and attachment for cover art.
chaptersFile string FFMETADATA chapters file; added as the last input and selected with -map_chapters <index>.
copyChapters boolean true/absent copies the source chapters (-map_chapters 0); false drops them. Defaults to copy for remux-style jobs.
audioSyncSeconds number Signed shift of the primary file's audio relative to its video, applied losslessly by re-reading the primary input and mapping only the shifted audio with -itsoffset. Positive = audio plays later.

RemuxInput input-index contract: primary is 0, additionalInputs occupy 1..N in array order, and chaptersFile takes N+1. Remux always appends the audio re-read entry last so its index is deterministic.

Demux adds no option fields either — each extracted stream becomes a normal job whose output and codec options are derived from the demux target (copy or convert). See docs/ARCHITECTURE_TRANSCODERS.md for the full flag-building rules and docs/FEATURES.md for the user-facing behavior.