Skip to content

botcity.plugins.recorder.plugin.BotRecorderPlugin (Thread)

A video recorder for your BotCity bot.

Parameters:

Name Type Description Default
bot BaseBot

The bot to record.

required
output_file str

The file to save the video to.

'output.avi'

frame_rate: int property writable

Frame rate of the recorder.

Returns:

Type Description
int

Frame rate of the recorder in frames per second.

scale: int property writable

Scale of the recorder.

Returns:

Type Description
int

Scale of the recorder in percent.

state: RecorderState property readonly

Get the recorder state.

Returns:

Type Description
RecorderState

Recorder state.

pause(self)

Pause the recorder.

resume(self)

Resume the recorder.

run(self)

Method representing the thread's activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object's constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

start(self)

Start the recorder.

stop(self)

Stop the recorder.