FrameRecorder (JavaCV 1.5.10 API)

java.lang.Object
- org.bytedeco.javacv.FrameRecorder

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

FFmpegFrameRecorder, OpenCVFrameRecorder
```
public abstract class FrameRecorder
extends Object
implements Closeable
```
Author:

Samuel Audet

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FrameRecorder.Exception

Nested Classes
Modifier and Type	Class and Description
`static class`	`FrameRecorder.Exception`

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`aspectRatio`
`protected int`	`audioBitrate`
`protected int`	`audioChannels`
`protected int`	`audioCodec`
`protected String`	`audioCodecName`
`protected Map<String,String>`	`audioMetadata`
`protected Map<String,String>`	`audioOptions`
`protected double`	`audioQuality`
`protected Map<String,Buffer>`	`audioSideData`
`protected Charset`	`charset`
`protected String`	`format`
`protected int`	`frameNumber`
`protected double`	`frameRate`
`protected int`	`gopSize`
`protected int`	`imageHeight`
`protected int`	`imageScalingFlags`
`protected int`	`imageWidth`
`protected boolean`	`interleaved`
`static List<String>`	`list`
`protected int`	`maxBFrames`
`protected int`	`maxDelay`
`protected Map<String,String>`	`metadata`
`protected Map<String,String>`	`options`
`protected int`	`pixelFormat`
`protected int`	`sampleFormat`
`protected int`	`sampleRate`
`protected long`	`timestamp`
`protected int`	`trellis`
`protected int`	`videoBitrate`
`protected int`	`videoCodec`
`protected String`	`videoCodecName`
`protected Map<String,String>`	`videoMetadata`
`protected Map<String,String>`	`videoOptions`
`protected double`	`videoQuality`
`protected Map<String,Buffer>`	`videoSideData`

Constructor Summary

Constructors
Constructor and Description

FrameRecorder()

Constructors
Constructor and Description
`FrameRecorder()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`static FrameRecorder`	`create(Class<? extends FrameRecorder> c, Class p, Object o, int w, int h)`
`static FrameRecorder`	`create(String className, File file, int width, int height)`
`static FrameRecorder`	`create(String className, String filename, int width, int height)`
`static FrameRecorder`	`createDefault(File file, int width, int height)`
`static FrameRecorder`	`createDefault(String filename, int width, int height)`
`abstract void`	`flush()`
`static Class<? extends FrameRecorder>`	`get(String className)`
`double`	`getAspectRatio()`
`int`	`getAudioBitrate()`
`int`	`getAudioChannels()`
`int`	`getAudioCodec()`
`String`	`getAudioCodecName()`
`Map<String,String>`	`getAudioMetadata()`
`String`	`getAudioMetadata(String key)`
`String`	`getAudioOption(String key)`
`Map<String,String>`	`getAudioOptions()`
`double`	`getAudioQuality()`
`Map<String,Buffer>`	`getAudioSideData()`
`Buffer`	`getAudioSideData(String key)`
`Charset`	`getCharset()`
`static Class<? extends FrameRecorder>`	`getDefault()`
`String`	`getFormat()`
`int`	`getFrameNumber()`
`double`	`getFrameRate()`
`int`	`getGopSize()`
`int`	`getImageHeight()`
`int`	`getImageScalingFlags()`
`int`	`getImageWidth()`
`int`	`getMaxBFrames()`
`int`	`getMaxDelay()`
`Map<String,String>`	`getMetadata()`
`String`	`getMetadata(String key)`
`String`	`getOption(String key)`
`Map<String,String>`	`getOptions()`
`int`	`getPixelFormat()`
`int`	`getSampleFormat()`
`int`	`getSampleRate()`
`long`	`getTimestamp()`
`int`	`getTrellis()`
`int`	`getVideoBitrate()`
`int`	`getVideoCodec()`
`String`	`getVideoCodecName()`
`Map<String,String>`	`getVideoMetadata()`
`String`	`getVideoMetadata(String key)`
`String`	`getVideoOption(String key)`
`Map<String,String>`	`getVideoOptions()`
`double`	`getVideoQuality()`
`Map<String,Buffer>`	`getVideoSideData()`
`Buffer`	`getVideoSideData(String key)`
`static void`	`init()`
`boolean`	`isInterleaved()`
`abstract void`	`record(Frame frame)`
`abstract void`	`release()`
`void`	`setAspectRatio(double aspectRatio)`
`void`	`setAudioBitrate(int audioBitrate)`
`void`	`setAudioChannels(int audioChannels)`
`void`	`setAudioCodec(int audioCodec)`
`void`	`setAudioCodecName(String audioCodecName)`
`void`	`setAudioMetadata(Map<String,String> metadata)`
`void`	`setAudioMetadata(String key, String value)`
`void`	`setAudioOption(String key, String value)`
`void`	`setAudioOptions(Map<String,String> options)`
`void`	`setAudioQuality(double audioQuality)`
`void`	`setAudioSideData(Map<String,Buffer> audioSideData)`
`void`	`setAudioSideData(String key, Buffer value)`
`void`	`setCharset(Charset charset)`
`void`	`setFormat(String format)`
`void`	`setFrameNumber(int frameNumber)`
`void`	`setFrameRate(double frameRate)`
`void`	`setGopSize(int gopSize)`
`void`	`setImageHeight(int imageHeight)`
`void`	`setImageScalingFlags(int imageScalingFlags)`
`void`	`setImageWidth(int imageWidth)`
`void`	`setInterleaved(boolean interleaved)`
`void`	`setMaxBFrames(int maxBFrames)`
`void`	`setMaxDelay(int maxDelay)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setMetadata(String key, String value)`
`void`	`setOption(String key, String value)`
`void`	`setOptions(Map<String,String> options)`
`void`	`setPixelFormat(int pixelFormat)`
`void`	`setSampleFormat(int sampleFormat)`
`void`	`setSampleRate(int sampleRate)`
`void`	`setTimestamp(long timestamp)`
`void`	`setTrellis(int trellis)`
`void`	`setVideoBitrate(int videoBitrate)`
`void`	`setVideoCodec(int videoCodec)`
`void`	`setVideoCodecName(String videoCodecName)`
`void`	`setVideoMetadata(Map<String,String> metadata)`
`void`	`setVideoMetadata(String key, String value)`
`void`	`setVideoOption(String key, String value)`
`void`	`setVideoOptions(Map<String,String> options)`
`void`	`setVideoQuality(double videoQuality)`
`void`	`setVideoSideData(Map<String,Buffer> videoSideData)`
`void`	`setVideoSideData(String key, Buffer value)`
`abstract void`	`start()`
`abstract void`	`stop()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

list
```
public static final List<String> list
```

format
```
protected String format
```

videoCodecName
```
protected String videoCodecName
```

audioCodecName
```
protected String audioCodecName
```

imageWidth
```
protected int imageWidth
```

imageHeight
```
protected int imageHeight
```

audioChannels
```
protected int audioChannels
```

pixelFormat
```
protected int pixelFormat
```

videoCodec
```
protected int videoCodec
```

videoBitrate
```
protected int videoBitrate
```

imageScalingFlags
```
protected int imageScalingFlags
```

gopSize
```
protected int gopSize
```

aspectRatio
```
protected double aspectRatio
```

frameRate
```
protected double frameRate
```

videoQuality
```
protected double videoQuality
```

sampleFormat
```
protected int sampleFormat
```

audioCodec
```
protected int audioCodec
```

audioBitrate
```
protected int audioBitrate
```

sampleRate
```
protected int sampleRate
```

audioQuality
```
protected double audioQuality
```

interleaved
```
protected boolean interleaved
```

charset
```
protected Charset charset
```

options
```
protected Map<String,String> options
```

videoOptions

protected Map<String,String> videoOptions

audioOptions

protected Map<String,String> audioOptions

metadata
```
protected Map<String,String> metadata
```

videoMetadata

protected Map<String,String> videoMetadata

audioMetadata

protected Map<String,String> audioMetadata

videoSideData

protected Map<String,Buffer> videoSideData

audioSideData

protected Map<String,Buffer> audioSideData

frameNumber
```
protected int frameNumber
```

timestamp
```
protected long timestamp
```

maxBFrames
```
protected int maxBFrames
```

trellis
```
protected int trellis
```

maxDelay
```
protected int maxDelay
```

Constructor Detail
- FrameRecorder
```
public FrameRecorder()
```

Method Detail

init
```
public static void init()
```

getDefault

public static Class<? extends FrameRecorder> getDefault()

get

public static Class<? extends FrameRecorder> get(String className)
                                          throws FrameRecorder.Exception

Throws:: FrameRecorder.Exception

create

public static FrameRecorder create(Class<? extends FrameRecorder> c,
                                   Class p,
                                   Object o,
                                   int w,
                                   int h)
                            throws FrameRecorder.Exception

Throws:: FrameRecorder.Exception

createDefault

public static FrameRecorder createDefault(File file,
                                          int width,
                                          int height)
                                   throws FrameRecorder.Exception

Throws:: FrameRecorder.Exception

createDefault

public static FrameRecorder createDefault(String filename,
                                          int width,
                                          int height)
                                   throws FrameRecorder.Exception

Throws:: FrameRecorder.Exception

create

public static FrameRecorder create(String className,
                                   File file,
                                   int width,
                                   int height)
                            throws FrameRecorder.Exception

Throws:: FrameRecorder.Exception

create

public static FrameRecorder create(String className,
                                   String filename,
                                   int width,
                                   int height)
                            throws FrameRecorder.Exception

Throws:: FrameRecorder.Exception

getFormat
```
public String getFormat()
```

setFormat
```
public void setFormat(String format)
```

getVideoCodecName
```
public String getVideoCodecName()
```

setVideoCodecName

public void setVideoCodecName(String videoCodecName)

getAudioCodecName
```
public String getAudioCodecName()
```

setAudioCodecName

public void setAudioCodecName(String audioCodecName)

getImageWidth
```
public int getImageWidth()
```

setImageWidth

public void setImageWidth(int imageWidth)

getImageHeight
```
public int getImageHeight()
```

setImageHeight

public void setImageHeight(int imageHeight)

getAudioChannels
```
public int getAudioChannels()
```

setAudioChannels

public void setAudioChannels(int audioChannels)

getPixelFormat
```
public int getPixelFormat()
```

setPixelFormat

public void setPixelFormat(int pixelFormat)

getVideoCodec
```
public int getVideoCodec()
```

setVideoCodec

public void setVideoCodec(int videoCodec)

getVideoBitrate
```
public int getVideoBitrate()
```

setVideoBitrate

public void setVideoBitrate(int videoBitrate)

getImageScalingFlags
```
public int getImageScalingFlags()
```

setImageScalingFlags

public void setImageScalingFlags(int imageScalingFlags)

getGopSize
```
public int getGopSize()
```

setGopSize
```
public void setGopSize(int gopSize)
```

getAspectRatio
```
public double getAspectRatio()
```

setAspectRatio

public void setAspectRatio(double aspectRatio)

getFrameRate
```
public double getFrameRate()
```

setFrameRate

public void setFrameRate(double frameRate)

getVideoQuality
```
public double getVideoQuality()
```

setVideoQuality

public void setVideoQuality(double videoQuality)

getSampleFormat
```
public int getSampleFormat()
```

setSampleFormat

public void setSampleFormat(int sampleFormat)

getAudioCodec
```
public int getAudioCodec()
```

setAudioCodec

public void setAudioCodec(int audioCodec)

getAudioBitrate
```
public int getAudioBitrate()
```

setAudioBitrate

public void setAudioBitrate(int audioBitrate)

getSampleRate
```
public int getSampleRate()
```

setSampleRate

public void setSampleRate(int sampleRate)

getAudioQuality
```
public double getAudioQuality()
```

setAudioQuality

public void setAudioQuality(double audioQuality)

isInterleaved
```
public boolean isInterleaved()
```

setInterleaved

public void setInterleaved(boolean interleaved)

getCharset
```
public Charset getCharset()
```

setCharset

public void setCharset(Charset charset)

getOptions

public Map<String,String> getOptions()

setOptions

public void setOptions(Map<String,String> options)

getVideoOptions

public Map<String,String> getVideoOptions()

setVideoOptions

public void setVideoOptions(Map<String,String> options)

getAudioOptions

public Map<String,String> getAudioOptions()

setAudioOptions

public void setAudioOptions(Map<String,String> options)

getMetadata

public Map<String,String> getMetadata()

setMetadata

public void setMetadata(Map<String,String> metadata)

getVideoMetadata

public Map<String,String> getVideoMetadata()

setVideoMetadata

public void setVideoMetadata(Map<String,String> metadata)

getAudioMetadata

public Map<String,String> getAudioMetadata()

setAudioMetadata

public void setAudioMetadata(Map<String,String> metadata)

getOption
```
public String getOption(String key)
```

setOption

public void setOption(String key,
                      String value)

getVideoOption

public String getVideoOption(String key)

setVideoOption

public void setVideoOption(String key,
                           String value)

getAudioOption

public String getAudioOption(String key)

setAudioOption

public void setAudioOption(String key,
                           String value)

getMetadata

public String getMetadata(String key)

setMetadata

public void setMetadata(String key,
                        String value)

getVideoMetadata

public String getVideoMetadata(String key)

setVideoMetadata

public void setVideoMetadata(String key,
                             String value)

getAudioMetadata

public String getAudioMetadata(String key)

setAudioMetadata

public void setAudioMetadata(String key,
                             String value)

getVideoSideData

public Map<String,Buffer> getVideoSideData()

setVideoSideData

public void setVideoSideData(Map<String,Buffer> videoSideData)

getVideoSideData

public Buffer getVideoSideData(String key)

setVideoSideData

public void setVideoSideData(String key,
                             Buffer value)

getAudioSideData

public Map<String,Buffer> getAudioSideData()

setAudioSideData

public void setAudioSideData(Map<String,Buffer> audioSideData)

getAudioSideData

public Buffer getAudioSideData(String key)

setAudioSideData

public void setAudioSideData(String key,
                             Buffer value)

getFrameNumber
```
public int getFrameNumber()
```

setFrameNumber

public void setFrameNumber(int frameNumber)

getTimestamp
```
public long getTimestamp()
```

setTimestamp

public void setTimestamp(long timestamp)

getMaxBFrames
```
public int getMaxBFrames()
```

setMaxBFrames

public void setMaxBFrames(int maxBFrames)

getTrellis
```
public int getTrellis()
```

setTrellis
```
public void setTrellis(int trellis)
```

getMaxDelay
```
public int getMaxDelay()
```

setMaxDelay

public void setMaxDelay(int maxDelay)

start

public abstract void start()
                    throws FrameRecorder.Exception

Throws:: FrameRecorder.Exception

flush

public abstract void flush()
                    throws FrameRecorder.Exception

Throws:: FrameRecorder.Exception

stop

public abstract void stop()
                   throws FrameRecorder.Exception

Throws:: FrameRecorder.Exception

record

public abstract void record(Frame frame)
                     throws FrameRecorder.Exception

Throws:: FrameRecorder.Exception

release

public abstract void release()
                      throws FrameRecorder.Exception

Throws:: FrameRecorder.Exception

close
```
public void close()
           throws FrameRecorder.Exception
```
Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

FrameRecorder.Exception

Class FrameRecorder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

list

format

videoCodecName

audioCodecName

imageWidth

imageHeight

audioChannels

pixelFormat

videoCodec

videoBitrate

imageScalingFlags

gopSize

aspectRatio

frameRate

videoQuality

sampleFormat

audioCodec

audioBitrate

sampleRate

audioQuality

interleaved

charset

options

videoOptions

audioOptions

metadata

videoMetadata

audioMetadata

videoSideData

audioSideData

frameNumber

timestamp

maxBFrames

trellis

maxDelay

Constructor Detail

FrameRecorder

Method Detail

init

getDefault

get

create

createDefault

createDefault

create

create

getFormat

setFormat

getVideoCodecName

setVideoCodecName

getAudioCodecName

setAudioCodecName

getImageWidth

setImageWidth

getImageHeight

setImageHeight

getAudioChannels

setAudioChannels

getPixelFormat

setPixelFormat

getVideoCodec

setVideoCodec

getVideoBitrate

setVideoBitrate

getImageScalingFlags

setImageScalingFlags

getGopSize

setGopSize

getAspectRatio

setAspectRatio

getFrameRate

setFrameRate

getVideoQuality