SDK/REFERENCE
Methods
Every method on the SDK. In React and Vue the same methods come from useEdithPro().
On this page
MethodReturnsWhat it does
init()Promise<void>Connects with your client ID and loads your styling. Safe to call more than once. Providers call it for you.
open()voidShows the ready-made popup.
close()voidHides the popup. Does not stop a recording.
record(settings?)Promise<Recording>Creates a recording in your workspace. Use its recording_encrypted_id with startCapture().
startCapture(id, settings?)voidStarts capturing for that recording. Accepts cameraId, micId and quality. Call init() first.
pause()voidPauses the recording.
resume()voidResumes after a pause.
stop()voidStops and saves.
delete()voidStops and permanently discards.
restart(settings?)Promise<void>Stops the current recording and starts a new one, with the last settings unless you pass new ones.
destroy()voidRemoves the SDK and everything it added to the page.
RecordSettings #
types.ts
interface RecordSettings { cameraId?: string; // from enumerateDevices() micId?: string; quality?: '720p' | '1080p' | '2K' | '4K'; folderId?: string; title?: string;}
Was this page helpful? @edithpro/sdk 1.0.5 · Edit this page