@revideo/core / exporter / Exporter
Interface: Exporter
Defined in: exporter/Exporter.ts:45
The main interface for implementing custom exporters.
Methods
configuration()?
optionalconfiguration():Promise<void|RendererSettings>
Defined in: exporter/Exporter.ts:54
Prepare the rendering configuration.
Returns
Promise<void | RendererSettings>
Remarks
Called at the beginning of the rendering process, before anything else has been set up. The returned value can be used to override the rendering settings provided by the user.
downloadVideos()?
optionaldownloadVideos(assetsInfo):Promise<void>
Defined in: exporter/Exporter.ts:104
Download all assets necessary for the export process
Parameters
assetsInfo
AssetInfo[][]
Returns
Promise<void>
generateAudio()?
optionalgenerateAudio(assetsInfo,startFrame,endFrame):Promise<void>
Defined in: exporter/Exporter.ts:95
Take in media assets per frame and generate audio track for the video.
Parameters
assetsInfo
AssetInfo[][]
startFrame
number
endFrame
number
Returns
Promise<void>
handleFrame()
handleFrame(
canvas,frame,sceneFrame,sceneName,signal):Promise<void>
Defined in: exporter/Exporter.ts:79
Export a frame.
Parameters
canvas
HTMLCanvasElement
A canvas containing the rendered frame.
frame
number
The frame number.
sceneFrame
number
The frame number within the scene.
sceneName
string
The name of the scene with which the frame is associated.
signal
AbortSignal
An abort signal triggered if the user aborts the rendering.
Returns
Promise<void>
Remarks
Called each time after a frame is rendered.
kill()?
optionalkill():Promise<void>
Defined in: exporter/Exporter.ts:124
Finish the rendering process.
Returns
Promise<void>
Remarks
Guaranteed to be called after the rendering has finished - no matter the result. Performs clean-up.
mergeMedia()?
optionalmergeMedia():Promise<void>
Defined in: exporter/Exporter.ts:90
after processing the image stream and generating an audio file, merge the video and audio stream as the final video
Returns
Promise<void>
start()?
optionalstart():Promise<void>
Defined in: exporter/Exporter.ts:65
Begin the rendering process.
Returns
Promise<void>
Remarks
Called after the rendering has been set up, right before the first frame
is rendered. Once start() is called, it is guaranteed that the stop()
method will be called as well. Can be used to initialize any resources that
require a clean-up.
stop()?
optionalstop(result):Promise<void>
Defined in: exporter/Exporter.ts:114
Finish the rendering process.
Parameters
result
The result of the rendering.
Returns
Promise<void>
Remarks
Called after rendering the visual elements has finished and audio so that audio track can be merged.