Rendley SDK

Appearance

Settings ​

You can configure global settings for the Rendley SDK, including output format, bitrate, decoding acceleration, and more.

Show Rendering Preview ​

If you prefer not to display frames as they are being rendered on the canvas, set the setShowRenderPreview property to false. By default, frames will be displayed.

typescript
Engine.getInstance().getSettings().setShowRenderPreview(false);

Rendering Videos with Alpha ​

To render videos that include an alpha channel, you need to use a codec that supports alpha, such as VP8 or VP9. Note that this feature is not supported by WebCodecs, so you'll need to switch to our WASM-based rendering approach.

typescript
Engine.getInstance().getSettings().setEncoderUseWebCodecs(false);
Engine.getInstance().getSettings().setEncoderUseAlpha(true);
Engine.getInstance().getSettings().setEncoderCodec("vp8");

Changing the Bitrate ​

To modify the encoding bitrate, use the following code:

typescript
Engine.getInstance().getSettings().setEncoderBitrate(1000000);

Changing the Encoder Codec ​

To change the encoder codec, you can do the following:

typescript
Engine.getInstance().getSettings().setEncoderCodec("vp8");

Changing the Encoding CRF ​

To adjust the Constant Rate Factor (CRF), use this code:

typescript
Engine.getInstance().getSettings().setEncoderCrf(24);

Changing Encoding and Decoding Acceleration ​

If you want to control the encoding and decoding acceleration, you can specify your preferences as follows:

typescript
Engine.getInstance()
  .getSettings()
  .setDecoderPreferredAcceleration("prefer-hardware");

Engine.getInstance()
  .getSettings()
  .setEncoderPreferredAcceleration("prefer-software");