ScreenRecorder

class ScreenRecorder : Extension

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

Constructors

Link copied to clipboard
fun ScreenRecorder()

Functions

Link copied to clipboard
open override fun afterDraw(drawer: Drawer, program: Program)
Link copied to clipboard
open override fun beforeDraw(drawer: Drawer, program: Program)
Link copied to clipboard
open override fun setup(program: Program)
Link copied to clipboard
open override fun shutdown(program: Program)

Properties

Link copied to clipboard
var contentScale: Double? = null
Link copied to clipboard
open override var enabled: Boolean = true
Link copied to clipboard
var frameClock: Boolean = true

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

Link copied to clipboard
var frameRate: Int = 30

the framerate of the output video

Link copied to clipboard
var frameSkip: Long = 0

how many frames to skip before starting to record

Link copied to clipboard
var height: Int? = null

optional height, overrides the program height

Link copied to clipboard
var maximumDuration: Double

the maximum duration in seconds

Link copied to clipboard
var maximumFrames: Long

the maximum duration in frames

Link copied to clipboard
var multisample: BufferMultisample? = null

should multisampling be used?

Link copied to clipboard
var outputFile: String? = null

the output file, auto-determined if left null

Link copied to clipboard
var outputToVideo: Boolean = true

is video recording enabled or paused?

Link copied to clipboard
var profile: VideoWriterProfile

the profile to use for the output video

Link copied to clipboard
var quitAfterMaximum: Boolean = true

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

Link copied to clipboard
var timeOffset: Double = 0.0

what time the video recorder should start recording at

Link copied to clipboard
var width: Int? = null

optional width, overrides the program width

Extensions

Link copied to clipboard
fun ScreenRecorder.h264(configure: H264Profile.() -> Unit)

Sources

Link copied to clipboard