@revideo/core / app / Renderer
Class: Renderer
Defined in: app/Renderer.ts:62
The rendering logic used by the editor to export animations.
Remarks
This class uses the PlaybackManager to render animations. In contrast to a
player, a renderer does not use an update loop. It plays through the
animation as fast as it can, occasionally pausing to keep the UI responsive.
The actual exporting is outsourced to an Exporter.
Constructors
Constructor
new Renderer(
project):Renderer
Defined in: app/Renderer.ts:88
Parameters
project
Returns
Renderer
Properties
estimator
readonlyestimator:TimeEstimator
Defined in: app/Renderer.ts:79
stage
readonlystage:Stage
Defined in: app/Renderer.ts:78
Accessors
onFinished
Get Signature
get onFinished():
Subscribable<RendererResult,EventHandler<RendererResult>>
Defined in: app/Renderer.ts:68
Returns
Subscribable<RendererResult, EventHandler<RendererResult>>
onFrameChanged
Get Signature
get onFrameChanged():
SubscribableValueEvent<number>
Defined in: app/Renderer.ts:73
Returns
SubscribableValueEvent<number>
onStateChanged
Get Signature
get onStateChanged():
SubscribableValueEvent<RendererState>
Defined in: app/Renderer.ts:63
Returns
SubscribableValueEvent<RendererState>
Methods
abort()
abort():
void
Defined in: app/Renderer.ts:179
Abort the ongoing render process.
Returns
void
frameToTime()
frameToTime(
frame):number
Defined in: app/Renderer.ts:130
Parameters
frame
number
Returns
number
getNumberOfFrames()
getNumberOfFrames(
settings):Promise<number>
Defined in: app/Renderer.ts:112
Returns number of frames that a project will have.
Parameters
settings
Returns
Promise<number>
render()
render(
settings):Promise<void>
Defined in: app/Renderer.ts:143
Render the animation using the provided settings.
Parameters
settings
The rendering settings.
Returns
Promise<void>
renderFrame()
renderFrame(
settings,time):Promise<void>
Defined in: app/Renderer.ts:194
Export an individual frame.
Parameters
settings
The rendering settings.
time
number
The timestamp to export.
Returns
Promise<void>
Remarks
This method always uses the default ImageExporter.
timeToFrame()
timeToFrame(
second):number
Defined in: app/Renderer.ts:134
Parameters
second
number
Returns
number