Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated SRT core statistics documentation #1199

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Updated SRT core statistics documentation #1199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d0def84
Saved intermediate work
mbakholdina Mar 18, 2020
adc6c8e
Saved intermediate work
mbakholdina Mar 20, 2020
1e37629
Saved intermediate work
mbakholdina Mar 20, 2020
e2e670d
Saved intermediate work
mbakholdina Mar 23, 2020
45be4a2
Did review of Accumulated statistics with Maxim
mbakholdina Mar 24, 2020
bc5081f
Saved intermediate work
mbakholdina Mar 25, 2020
6c53194
Finished with accumulated statistics
mbakholdina Mar 26, 2020
bff5ca0
Fixed misprint
mbakholdina Mar 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/API-functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ be called from the C++ global destructor, if not called by the application, alth
relying on this behavior is stronly discouraged.

- Returns:

* 0 (A possibility to return other values is reserved for future use)

**IMPORTANT**: Note that the startup/cleanup calls have an instance counter.
Expand Down Expand Up @@ -837,7 +837,7 @@ are then derived by the member sockets.
* `SRT_EINVSOCK`: Socket `u` indicates no valid socket ID
* `SRT_EINVOP`: Option `opt` indicates no valid option
* Various other errors that may result from problems when setting a specific
option (see option description for details).
option (see option description for details).

### srt_getversion

Expand Down Expand Up @@ -1311,7 +1311,7 @@ would be 0x7FFFFFE0, the "distance" is 0x20.
// perfmon with Byte counters for better bitrate estimation.
int srt_bstats(SRTSOCKET u, SRT_TRACEBSTATS * perf, int clear);

// permon with Byte counters and instantaneous stats instead of moving averages for Snd/Rcvbuffer sizes.
// perfmon with Byte counters and instantaneous stats instead of moving averages for Snd/Rcvbuffer sizes.
int srt_bistats(SRTSOCKET u, SRT_TRACEBSTATS * perf, int clear, int instantaneous);
```

Expand Down Expand Up @@ -1436,7 +1436,7 @@ level-triggered, you can do two separate subscriptions for the same socket.


- Returns:

* 0 if successful, otherwise -1

- Errors:
Expand All @@ -1461,7 +1461,7 @@ The `_usock` suffix refers to a user socket (SRT socket).
The `_ssock` suffix refers to a system socket.

- Returns:

* 0 if successful, otherwise -1

- Errors:
Expand Down
Loading