openrndr-ffmpeg/org.openrndr.ffmpeg

Package-level declarations

Types

FrameEvent

class FrameEvent(val frame: ColorBuffer, val timeStamp: Double)

H264Profile

class H264Profile : VideoWriterProfile

MetadataContainer

@Serializable

data class MetadataContainer(val streams: List<MetadataStream>, val format: MetadataFormat)

MetadataFormat

@Serializable

data class MetadataFormat(val filename: String? = null, val size: Int? = null, val start_time: Double? = null, val duration: Double? = null, val bit_rate: Int? = null, val nb_streams: Int? = null)

MetadataRetriever

class MetadataRetriever

A class to retrieve metadata, typically from video files, but compatible with any media accepted by ffprobe.

MetadataStream

@Serializable

data class MetadataStream(val width: Int? = null, val height: Int? = null, val codec_type: String? = null, val codec_name: String? = null, val pix_fmt: String? = null, val bit_rate: Int? = null, val nb_frames: Int? = null, val sample_rate: Int? = null, val channels: Int? = null)

PlayMode

enum PlayMode : Enum<PlayMode>

ScreenRecorder

class ScreenRecorder : Extension

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

State

enum State : Enum<State>

VideoEvent

class VideoEvent

VideoPlayerConfiguration

class VideoPlayerConfiguration

VideoPlayerFFMPEG

class VideoPlayerFFMPEG

Video player based on FFMPEG

VideoStatistics

class VideoStatistics

VideoWriter

class VideoWriter(val useVariableFrameRate: Boolean = false)

VideoWriterProfile

abstract class VideoWriterProfile

Properties

fileWithoutExtension

val File.fileWithoutExtension: File

Functions

h264

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

loadVideo

fun Program.loadVideo(fileOrUrl: String, mode: PlayMode = PlayMode.BOTH, configuration: VideoPlayerConfiguration = VideoPlayerConfiguration()): VideoPlayerFFMPEG

Load a video

loadVideoDevice

fun loadVideoDevice(deviceName: String = VideoPlayerFFMPEG.defaultDevice(), mode: PlayMode = PlayMode.VIDEO, width: Int? = null, height: Int? = null, frameRate: Double? = null, configuration: VideoPlayerConfiguration = VideoPlayerConfiguration()): VideoPlayerFFMPEG