User API¶
Python API Reference¶
screen_recorder_sdk.screen_recorder¶
-
class
screen_recorder_sdk.screen_recorder.
RecorderParams
(desktop_num=0, pid=0) Bases:
object
inputs parameters for init_resources method
- Parameters
desktop_num (int) – desktop num, counting from 0
pid (int) – pid of process to capture
-
exception
screen_recorder_sdk.screen_recorder.
RecorderError
(message, exit_code) Bases:
Exception
This exception is raised if non-zero exit code is returned from C code
- Parameters
message (str) – exception message
exit_code (int) – exit code from low level API
-
screen_recorder_sdk.screen_recorder.
init_resources
(params) Init resources for recording
- Parameters
params (RecorderParams) – params for recording
- Raises
RecorderError – if non zero exit code returned from low level API
-
screen_recorder_sdk.screen_recorder.
get_screenshot
(max_attempts=1) Get Screenshot
- Parameters
max_attempts (int) – max attempts to capture frame buffer
- Returns
Pillow Image
- Return type
Pillow Image
- Raises
RecorderError – if non zero exit code returned from low level API
-
screen_recorder_sdk.screen_recorder.
get_pid
() Get PID
- Return type
int
- Returns
PID
- Raises
RecorderError – if non zero exit code returned from low level API
-
screen_recorder_sdk.screen_recorder.
free_resources
() Free Resources
- Raises
RecorderError – if non zero exit code returned from low level API
-
screen_recorder_sdk.screen_recorder.
enable_log
() Enable Logger
- Raises
RecorderError – if non zero exit code returned from low level API
-
screen_recorder_sdk.screen_recorder.
enable_dev_log
() Enable Dev Logger
- Raises
RecorderError – if non zero exit code returned from low level API
-
screen_recorder_sdk.screen_recorder.
disable_log
() Disable Logger
- Raises
RecorderError – if non zero exit code returned from low level API
-
screen_recorder_sdk.screen_recorder.
start_video_recording
(filename, frame_rate=30, bit_rate=8000000, use_hw_transfowrms=True) Start Video Recording
- Parameters
filename (str) – filename to store video
frame_rate (int) – FPS
bit_rate (int) – bit rate, set higher values for better quality
use_hw_transforms – if you have good GPU set this flag to True for better perf, if you see errors try to set it to false
- Raises
RecorderError – if non zero exit code returned from low level API
-
screen_recorder_sdk.screen_recorder.
stop_video_recording
() Stop video recording
- Raises
RecorderError – if non zero exit code returned from low level API
-
screen_recorder_sdk.screen_recorder.
set_log_file
(log_file) redirect logger from stderr to file, can be called any time :param log_file: log file name :type log_file: str :raises RecorderError: if non zero exit code returned from low level API
screen_recorder_sdk.exit_codes¶
-
class
screen_recorder_sdk.exit_codes.
RecorderExitCodes
(value) Bases:
enum.Enum
Enum to store all possible exit codes
-
STATUS_OK
= 0
-
NO_SUCH_PROCESS_ERROR
= 100
-
RECORDING_ALREADY_RUN_ERROR
= 101
-
RECORDING_THREAD_ERROR
= 102
-
RECORDING_THREAD_IS_NOT_RUNNING_ERROR
= 103
-
INVALID_ARGUMENTS_ERROR
= 104
-
SESSION_NOT_CREATED_ERROR
= 105
-
PREPARE_DESK_DUPL_ERROR
= 106
-
CREATE_TEXTURE_ERROR
= 107
-
DDA_CAPTURE_ERROR
= 108
-
FIND_WINDOW_ERROR
= 109
-
DDA_LOST_ACCESS_ERROR
= 110
-
DDA_TIMEOUT_ERROR
= 111
-
SYNC_TIMEOUT_ERROR
= 112
-
GENERAL_ERROR
= 113
-