CameraVideoRecording#

class ansys.stk.core.graphics.CameraVideoRecording#

Records the 3D window to either a movie file or to consecutively ordered image files each time the scene is rendered.

Overview#

start_recording

Do not use this method, as it is deprecated. Use the overload taking a video format instead. Starts recording a file in the WMV format at the specified bit and frame rate.

start_recording_frame_stack

Start recording a frame stack. Each frame is saved as a separate image file. The filename of each frame is defined by a prefix followed by a frame number.

stop_recording

Stop recording.

start_recording_video

Start recording a video file at the specified bit and frame rate.

is_recording

Get if recording is occurring or not.

Import detail#

from ansys.stk.core.graphics import CameraVideoRecording

Property detail#

property CameraVideoRecording.is_recording: bool#

Get if recording is occurring or not.

Method detail#

CameraVideoRecording.start_recording(self, wmv_filename: str, video_bit_rate: int, video_frame_rate: int) None#

Do not use this method, as it is deprecated. Use the overload taking a video format instead. Starts recording a file in the WMV format at the specified bit and frame rate.

Parameters:

wmv_filename : str

video_bit_rate : int

video_frame_rate : int

Returns:

None

CameraVideoRecording.start_recording_frame_stack(self, file_directory: str, file_prefix: str, camera_snapshot_file_format: SnapshotFileFormat, starting_frame_number: int, number_of_frame_digits: int) None#

Start recording a frame stack. Each frame is saved as a separate image file. The filename of each frame is defined by a prefix followed by a frame number.

Parameters:

file_directory : str

file_prefix : str

camera_snapshot_file_format : SnapshotFileFormat

starting_frame_number : int

number_of_frame_digits : int

Returns:

None

CameraVideoRecording.stop_recording(self) None#

Stop recording.

Returns:

None

CameraVideoRecording.start_recording_video(self, file_directory: str, file_prefix: str, video_format: VideoFormat, video_bit_rate: int, video_frame_rate: int) None#

Start recording a video file at the specified bit and frame rate.

Parameters:

file_directory : str

file_prefix : str

video_format : VideoFormat

video_bit_rate : int

video_frame_rate : int

Returns:

None