etiennedub / pyk4a

Python 3 wrapper for Azure-Kinect-Sensor-SDK
MIT License
288 stars 81 forks source link

Enhancement/no more sync problems because better documentation #10

Closed lpasselin closed 4 years ago

lpasselin commented 4 years ago

Makes it clear that get_capture can sometimes return None if config argument sync_images is False.

Added documentation explaining how to use the get_capture function properly.

Typehinting required adding numpy import. This should benefit users using ide with typehint support.

Split in two subfunctions, _get_capture_color and _get_capture_depth, which allows cleaner typehinting. Using typing.Unions of typing.Unions would have been a mess.