pyrealsense2.video_frame¶

class pyrealsense2.video_frame¶

Extends the frame class with additional video related attributes and functions.

__init__(self: pyrealsense2.video_frame, arg0: pyrealsense2.frame) → None¶

Methods

`__init__`((self: pyrealsense2.video_frame, ...)
`as_depth_frame`(...)
`as_frame`(...)
`as_frameset`(...)
`as_motion_frame`(...)
`as_points`(...)
`as_pose_frame`(...)
`as_video_frame`(...)
`get_bits_per_pixel`(...)	Retrieve bits per pixel.
`get_bytes_per_pixel`(...)	Retrieve bytes per pixel.
`get_data`(...)	Retrieve data from the frame handle.
`get_data_size`((self: pyrealsense2.frame) -> int)	Retrieve data size from frame handle.
`get_frame_metadata`(...)	Retrieve the current value of a single frame_metadata.
`get_frame_number`(...)	Retrieve the frame number.
`get_frame_timestamp_domain`(...)	Retrieve the timestamp domain.
`get_height`(...)	Returns image height in pixels.
`get_profile`(...)	Retrieve stream profile from frame handle.
`get_stride_in_bytes`(...)	Retrieve frame stride, meaning the actual line width in memory in bytes (not the logical image width).
`get_timestamp`(...)	Retrieve the time at which the frame was captured
`get_width`(...)	Returns image width in pixels.
`is_depth_frame`(...)
`is_frame`((self: pyrealsense2.frame) -> bool)
`is_frameset`((self: pyrealsense2.frame) -> bool)
`is_motion_frame`(...)
`is_points`((self: pyrealsense2.frame) -> bool)
`is_pose_frame`((self: pyrealsense2.frame) -> bool)
`is_video_frame`(...)
`keep`((self: pyrealsense2.frame) -> None)	Keep the frame, otherwise if no refernce to the frame, the frame will be released.
`supports_frame_metadata`(...)	Determine if the device allows a specific metadata to be queried.
`swap`((self: pyrealsense2.frame, ...)	Swap the internal frame handle with the one in parameter

Attributes

`bits_per_pixel`	Bits per pixel.
`bytes_per_pixel`	Bytes per pixel.
`data`	Data from the frame handle.
`frame_number`	The frame number.
`frame_timestamp_domain`	The timestamp domain.
`height`	Image height in pixels.
`profile`	Stream profile from frame handle.
`stride_in_bytes`	Frame stride, meaning the actual line width in memory in bytes (not the logical image width).
`timestamp`	Time at which the frame was captured.
`width`	Image width in pixels.

bits_per_pixel¶: Bits per pixel. Identical to calling get_bits_per_pixel.

bytes_per_pixel¶: Bytes per pixel. Identical to calling get_bytes_per_pixel.

get_bits_per_pixel(self: pyrealsense2.video_frame) → int¶: Retrieve bits per pixel.

get_bytes_per_pixel(self: pyrealsense2.video_frame) → int¶: Retrieve bytes per pixel.

get_height(self: pyrealsense2.video_frame) → int¶: Returns image height in pixels.

get_stride_in_bytes(self: pyrealsense2.video_frame) → int¶: Retrieve frame stride, meaning the actual line width in memory in bytes (not the logical image width).

get_width(self: pyrealsense2.video_frame) → int¶: Returns image width in pixels.

height¶: Image height in pixels. Identical to calling get_height.

stride_in_bytes¶: Frame stride, meaning the actual line width in memory in bytes (not the logical image width). Identical to calling get_stride_in_bytes.

width¶: Image width in pixels. Identical to calling get_width.