NVIDIA / NVIDIA/nvapi

`averageEncodeLatency` is in microseconds, but incorrectly documented as milliseconds

Open
#18 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
239
Forks
39
PR merge metrics
No merged PRs in 30d

Description

https://github.com/NVIDIA/nvapi/blob/7cb76fce2f52de818b3da497af646af1ec16ce27/nvapi.h#L4663

    NvU32             averageEncodeLatency;        //!< Moving average encode latency in milliseconds.

When using a VR streaming headset, this is reporting an active session with ~ 900 latency - it is very clear that I am not playing VR with nearly a second of latency.

Based on nvidia-smi, this field is incorrectly documented, and is actually microseconds, not milliseconds:

PS C:\Windows\System32\DriverStore\FileRepository\nvmdi.inf_amd64_fe5a9cae5c641286> .\nvidia-smi encodersessions
# GPU Session    Process   Codec       H       V Average     Average
    0      32      23520   H.265    1792    1856     305         869
    0      32      23520   H.265    1792    1856     266         918
    0      32      23520   H.265    1792    1856     298         982
    0      32      23520   H.265    1792    1856     307         939

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open nvapi.h around line 4663 and compare the averageEncodeLatency comment with the nvidia-smi encodersessions output described in the issue. Update the unit documentation to match the observed field value, then review the header diff for consistency.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.