Document functions

[bertelschmitt]

I’m beginning to use ffmpgcv with success.
Could you please, if applicable, document the usage in Python for subfunctions such as

get_info
get_info_precise
get_num_NVIDIA_GPUs
get_num_QSV_GPUs
encoder_to_nvidia
encoder_to_qsv(
decoder_to_nvidia
decoder_to_qsv
run_async
run_async_reader
release_process
release_process_writer

And any others I might have missed.

Thank you.

B

P.S.: If you need help with writing the documentation, please let me know.

[chenxinfeng4]

Thank you for your interest in the FFMPEGCV project. I would like to document the subfunctions and make FFMPEGCV more standardized. Is there a specific template or tutorial that you would recommend for me to follow? Alternatively, should I simply add comments directly within the code files for each subfunction?

[bertelschmitt]

Why not follow how OpenCV does it for their Videocapture/Videowriter? Say what a function does, what parameters the function expects, what parameters are returned. Along with a few lines of example code.

I don't think comments in the source will be sufficient.

[chenxinfeng4]

The common functions like "Videocapture/Videowriter" share the most same INPUT/OUTPUT parameters. The sub-functions, I did not want to disturb users, have already been called by the common functions. Users are not suggested to use sub-functions directly.

[bertelschmitt]

Please write the docs.