Skip to content

Commit

Permalink
[ADD] Added Globals documentation.
Browse files Browse the repository at this point in the history
[CHANGE] Changed internal documentation in VoIP.py.
[CHANGE] Changed tox.ini file to update new flake8 settings.
  • Loading branch information
tayler6000 committed Sep 17, 2022
1 parent 2c6ae27 commit f100084
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 5 deletions.
10 changes: 10 additions & 0 deletions docs/Globals.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Global Variables
########

There are a few global variables that may assist you if you're having problems with the library.

pyVoIP.\ **DEBUG** = False
If set to true, pyVoIP will print debug messages that may be useful if you need to open a GitHub issue. Otherwise, does nothing.

pyVoIP.\ **TRANSMIT_DELAY_REDUCTION** = 0.0
The higher this variable is, the more often RTP packets are sent. This *should* only ever need to be 0.0. However, when testing on Windows, there has sometimes been jittering, setting this to 0.75 fixed this in testing, but you may need to tinker with this number on a per-system basis.
3 changes: 2 additions & 1 deletion pyVoIP/VoIP.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,8 @@ def __init__(
)
assoc[int(x)] = p
except ValueError:
# sometimes rtpmap raise a KeyError because fmtp is set instate
# Sometimes rtpmap raise a KeyError because fmtp
# is set instate
pt = i["attributes"][x]["rtpmap"]["name"]
warnings.warn(
f"RTP Payload type {pt} not found.",
Expand Down
6 changes: 2 additions & 4 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
[flake8]
ignore =
# Default Ignore's removed:
# E226: missing whitespace around arithmatic operator
# E241: multiple spaces after ','
# E242: tab after ','
# E203 whitespace before ':'
# W503 line break before binary operator
E121,E123,E126,E133,E704,W504
E203,W503

0 comments on commit f100084

Please sign in to comment.