StarMirror/toxcore
1
0
Fork 0
mirror of https://github.com/irungentoo/toxcore.git synced 2024-03-22 13:30:51 +08:00
Code Issues Projects Releases Wiki Activity

Fix typos in docs

Browse Source
This commit is contained in:
dartraiden 2017-08-22 21:49:48 +03:00 committed by Robin Lindén
parent 9e43d678fb
commit 987ad5eac1
No known key found for this signature in database
GPG Key ID: 601A604B7E605776
4 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
INSTALL.md
View File

@ -269,7 +269,7 @@ export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
#### Cross-compile
It's a bit challenging to build Tox and all of its dependencies nativly on Windows, so we will show an easier, less error and headache prone method of building it -- cross-compiling.
It's a bit challenging to build Tox and all of its dependencies natively on Windows, so we will show an easier, less error and headache prone method of building it -- cross-compiling.
##### Setting up a VM

2
docs/TCP_Network.txt
View File

@ -23,7 +23,7 @@ public key.
4. Bob receives an onion packet from Alice telling him which nodes she is
connected to. Bob connects to these nodes and establishes a routed connection
with alice using that temporary public key.
with Alice using that temporary public key.
5. That connection is used by both to transmit encrypted Messenger and A/V
packets.

8
docs/av_api.md
View File

@ -10,7 +10,7 @@ phone_t* initPhone(uint16_t _listen_port, uint16_t _send_port);
function initializes sample phone. _listen_port and _send_port are variables only meant
for local testing. You will not have to do anything regarding to that since
everything will be started within a mesenger.
everything will be started within a messenger.
Phone requires one msi session and two rtp sessions ( one for audio and one for
@ -78,7 +78,7 @@ Hangs up active call
```
int msi_answer ( msi_session_t* _session, call_type _call_type );
```
Answer incomming call. _call_type set's callee call type.
Answer incoming call. _call_type set's callee call type.
```
int msi_cancel ( msi_session_t* _session );
@ -88,7 +88,7 @@ Cancel current request.
```
int msi_reject ( msi_session_t* _session );
```
Reject incomming call.
Reject incoming call.
### Now for rtp:
@ -169,7 +169,7 @@ void *encode_audio_thread(void *arg);
```
Spawns the audio encoding thread. The argument should hold a pointer to a codec_state.
This function should only be called if audio encoding is supported (when init_send_audio returns 1).
Audio frames are read from the selected audio capture device during intitialisation. This audio capturing can be rerouted to a different device on the fly.
Audio frames are read from the selected audio capture device during initialisation. This audio capturing can be rerouted to a different device on the fly.
Each audio frame is encoded into a packet, and sent via RTP. All audio frames have the same amount of samples, which is defined in AV_codec.h.
```
int video_decoder_refresh(codec_state *cs, int width, int height);

2
docs/updates/Crypto.md
View File

@ -46,7 +46,7 @@ Crypto request packets
--------------------------------------
```
[char with a value of 32][Bob (The reciever's) Public key (client_id) (32 bytes))][Alice's (The sender's) Public key (client_id) (32 bytes)][Random nonce (24 bytes)][Encrypted message]
[char with a value of 32][Bob (The receiver's) Public key (client_id) (32 bytes))][Alice's (The sender's) Public key (client_id) (32 bytes)][Random nonce (24 bytes)][Encrypted message]
```
The encrypted message is encrypted with crypto_box() (using Bob's public key, Alice's private key and the nonce (randomly generated 24 bytes)) and is a message from Alice in which she tells Bob who she is.