Skip to content

Add clearer documentation #123

@wiiznokes

Description

@wiiznokes

Hi, this is a great crate, and i know the read me have a lot of information, but i found it quite difficult to integrate this crate in my app.

Just wanted to let you know where i had some issue in case you want to improve the documentation

  • What is FFT
  • How to determine FixedSync. I still don't see how the input could not be fixed if we give a chunk_size
  • what is sub_chunks and what is the use case/good default value
  • what is the use of partial_len in Indexing. If i understand correctly, this is just a safeguard.
    Edit: I didn't see it was documented in process_into_buffer. But it say it will insert silence into the buffer, but if i set a value inferior to input_frames_next, i get an error
  • Document somewhere input_frames_next, because one could expect to give a buffer of size chunk_size at each iteration

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions