io.agora.recording

Class RecorderVideoFrameCaptureConfig

java.lang.Object

io.agora.recording.RecorderVideoFrameCaptureConfig

public class RecorderVideoFrameCaptureConfig
extends java.lang.Object

Recorder video frame capture configuration.

Defaults:

• videoFrameType: VIDEO_FORMAT_ENCODED_FRAME_TYPE
• jpgFileStorePath: null
• jpgCaptureIntervalInSec: 5
• observer: null

Field Summary

Fields

Modifier and Type	Field and Description
private int	jpgCaptureIntervalInSec The interval of the video frame capture for jpg in seconds.The default value is 5 seconds, min 1 seconds
private java.lang.String	jpgFileStorePath Specifies the absolute path to the directory where JPG files will be saved.
private IRecorderVideoFrameObserver	observer The observer to get the video frame.
private Constants.VideoFrameCaptureType	videoFrameType The video frame capture type.

Constructor Summary

Constructors

Constructor and Description
RecorderVideoFrameCaptureConfig()

Method Summary

Modifier and Type	Method and Description
int	getJpgCaptureIntervalInSec()
java.lang.String	getJpgFileStorePath()
IRecorderVideoFrameObserver	getObserver()
Constants.VideoFrameCaptureType	getVideoFrameType()
void	setJpgCaptureIntervalInSec(int jpgCaptureIntervalInSec)
void	setJpgFileStorePath(java.lang.String jpgFileStorePath)
void	setObserver(IRecorderVideoFrameObserver observer)
void	setVideoFrameType(Constants.VideoFrameCaptureType videoFrameType)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

videoFrameType

private Constants.VideoFrameCaptureType videoFrameType

The video frame capture type.

jpgFileStorePath

private java.lang.String jpgFileStorePath

Specifies the absolute path to the directory where JPG files will be saved. When videoFrameType is set to VIDEO_FORMAT_JPG_FILE_TYPE and jpgFileStorePath is not null, the JPG file will be saved to this directory. The filename will follow the format: "channelId_userId_YYYYMMDDHHMMSS_MS.jpg". Make sure that the specified directory already exists and is writable. Note: Make sure that you set this parameter when capturing VIDEO_FORMAT_JPG_FILE_TYPE; otherwise the captured JPG files will not be saved.

jpgCaptureIntervalInSec

private int jpgCaptureIntervalInSec

The interval of the video frame capture for jpg in seconds.The default value is 5 seconds, min 1 seconds

observer

private IRecorderVideoFrameObserver observer

The observer to get the video frame.

Constructor Detail

RecorderVideoFrameCaptureConfig

public RecorderVideoFrameCaptureConfig()

Method Detail

getVideoFrameType

public Constants.VideoFrameCaptureType getVideoFrameType()

setVideoFrameType

public void setVideoFrameType(Constants.VideoFrameCaptureType videoFrameType)

getJpgFileStorePath

public java.lang.String getJpgFileStorePath()

setJpgFileStorePath

public void setJpgFileStorePath(java.lang.String jpgFileStorePath)

getJpgCaptureIntervalInSec

public int getJpgCaptureIntervalInSec()

setJpgCaptureIntervalInSec

public void setJpgCaptureIntervalInSec(int jpgCaptureIntervalInSec)

getObserver

public IRecorderVideoFrameObserver getObserver()

setObserver

public void setObserver(IRecorderVideoFrameObserver observer)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object