org.arquillian.extension.recorder.video

Interface Recorder

public interface Recorder

Implementations of this interface are capable of recording videos.

Author:

Stefan Miklosovic

Method Summary

Modifier and Type	Method and Description
int	getFrameRate()
VideoType	getVideoType()
void	init(VideoConfiguration configuration) Initializes particular video recorder implementation, e.g.
Recorder	setFrameRate(int framerate)
Recorder	setMessage(String message) You have access to this message in resulting report so you can document what some video actually means.
Recorder	setVideoTargetDir(File videoTargetDir)
Recorder	setVideoTargetDir(String videoTargetDir)
Recorder	setVideoType(VideoType videoType)
void	startRecording() Starts to record your test.
void	startRecording(File file) Starts to record your test.
void	startRecording(File file, VideoType videoType) Starts to record your test.
void	startRecording(String fileName) Starts to record your test.
void	startRecording(String fileName, VideoType videoType) Starts to record your test.
void	startRecording(VideoType videoType) Starts to record your test.
Video	stopRecording() Stops to record your video after you started it with startRecording()

Method Detail

init

void init(VideoConfiguration configuration)

Initializes particular video recorder implementation, e.g. by setting target directory where all videos will be saved afterwards.

Parameters:

configuration - configuration of this video recorder implementation

startRecording

void startRecording()

Starts to record your test.

startRecording

void startRecording(VideoType videoType)

Starts to record your test.

Parameters:

videoType - type of video you want to get

startRecording

void startRecording(String fileName)

Starts to record your test.

Parameters:

fileName - name of video you want to start to record

startRecording

void startRecording(File file)

Starts to record your test.

Parameters:

file - file where to save recorded video

startRecording

void startRecording(String fileName,
                    VideoType videoType)

Starts to record your test.

Parameters:

fileName - name of video you want to start to record

videoType - type of video you want to start to record

startRecording

void startRecording(File file,
                    VideoType videoType)

Starts to record your test.

Parameters:

file - file where to save recorder video

videoType - type of video you want to start to record

setVideoTargetDir

Recorder setVideoTargetDir(String videoTargetDir)

Parameters:

videoTargetDir - name of directory you want to save all videos to

Returns:

this recorder

setVideoTargetDir

Recorder setVideoTargetDir(File videoTargetDir)

Parameters:

videoTargetDir - directory you want to save all videos to

Returns:

this recorder

setVideoType

Recorder setVideoType(VideoType videoType)

Parameters:

videoType - type of video you want all videos to be

Returns:

this recorder

getVideoType

VideoType getVideoType()

Returns:

type of video will will be recorder

stopRecording

Video stopRecording()

Stops to record your video after you started it with startRecording()

Returns:

recorded video

setFrameRate

Recorder setFrameRate(int framerate)

Parameters:

framerate - of recorder videos

Returns:

this recorder

getFrameRate

int getFrameRate()

Returns:

actual framerate

setMessage

Recorder setMessage(String message)

You have access to this message in resulting report so you can document what some video actually means. If message is a null object, it should not be added to the resulting report. If this method is called before all recorded videos, all videos will share the same message.

Parameters:

message - message to add for to be recorded video

Returns:

this recorder