openrndr-ffmpeg/org.openrndr.ffmpeg/ScreenRecorder

ScreenRecorder

class ScreenRecorder : Extension(source)

ScreenRecorder extension can be used to record to contents of a Program to a video

Constructors

ScreenRecorder

constructor()

Properties

contentScale

var contentScale: Double?

enabled

open override var enabled: Boolean

finished

val finished: Event<ScreenRecorder>

frameClock

var frameClock: Boolean

should a frameclock be installed, if false system clock is used

frameRate

var frameRate: Int

the framerate of the output video

frameSkip

var frameSkip: Long

how many frames to skip before starting to record

height

var height: Int?

optional height, overrides the program height

maximumDuration

var maximumDuration: Double

the maximum duration in seconds

maximumFrames

var maximumFrames: Long

the maximum duration in frames

multisample

var multisample: BufferMultisample?

should multisampling be used?

outputFile

var outputFile: String?

the output file, auto-determined if left null

outputToVideo

var outputToVideo: Boolean

is video recording enabled or paused?

profile

var profile: VideoWriterProfile

the profile to use for the output video

quitAfterMaximum

var quitAfterMaximum: Boolean

when set to true, program.application.exit() will be issued after the maximum duration has been reached

timeOffset

var timeOffset: Double

what time the video recorder should start recording at

width

var width: Int?

optional width, overrides the program width

Functions

afterDraw

open override fun afterDraw(drawer: Drawer, program: Program)

beforeDraw

open override fun beforeDraw(drawer: Drawer, program: Program)

h264

fun ScreenRecorder.h264(configure: H264Profile.() -> Unit)

setup

open override fun setup(program: Program)

shutdown

open override fun shutdown(program: Program)