Skip to content

Commit 9448e26

Browse files
mbakholdinamaxsharabayko
authored andcommitted
[docs] Minor updates to AEAD docs plus changed v1.6.0 to 1.5.2 in some files
1 parent 3cefede commit 9448e26

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

docs/API/API-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ Since SRT v1.5.0.
171171
| [SRT_REJ_FILTER](#SRT_REJ_FILTER) | 1.3.4 | The [`SRTO_PACKETFILTER`](API-socket-options.md#SRTO_PACKETFILTER) option has been set differently on both connection parties |
172172
| [SRT_REJ_GROUP](#SRT_REJ_GROUP) | 1.4.2 | The group type or some group settings are incompatible for both connection parties |
173173
| [SRT_REJ_TIMEOUT](#SRT_REJ_TIMEOUT) | 1.4.2 | The connection wasn't rejected, but it timed out |
174-
| [SRT_REJ_CRYPTO](#SRT_REJ_CRYPTO) | 1.6.0-dev | The connection was rejected due to an unsupported or mismatching encryption mode |
174+
| [SRT_REJ_CRYPTO](#SRT_REJ_CRYPTO) | 1.5.2 | The connection was rejected due to an unsupported or mismatching encryption mode |
175175
| <img width=290px height=1px/> | | |
176176

177177
<h4 id="error-codes">Error Codes</h4>

docs/API/API-socket-options.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ The following table lists SRT API socket options in alphabetical order. Option d
204204
| [`SRTO_BINDTODEVICE`](#SRTO_BINDTODEVICE) | 1.4.2 | pre-bind | `string` | | | | RW | GSD+ |
205205
| [`SRTO_CONGESTION`](#SRTO_CONGESTION) | 1.3.0 | pre | `string` | | "live" | \* | W | S |
206206
| [`SRTO_CONNTIMEO`](#SRTO_CONNTIMEO) | 1.1.2 | pre | `int32_t` | ms | 3000 | 0.. | W | GSD+ |
207-
| [`SRTO_CRYPTOMODE`](#SRTO_CRYPTOMODE) | 1.6.0-dev | pre | `int32_t` | | 0 (Auto) | [0, 2] | W | GSD |
207+
| [`SRTO_CRYPTOMODE`](#SRTO_CRYPTOMODE) | 1.5.2 | pre | `int32_t` | | 0 (Auto) | [0, 2] | W | GSD |
208208
| [`SRTO_DRIFTTRACER`](#SRTO_DRIFTTRACER) | 1.4.2 | post | `bool` | | true | | RW | GSD |
209209
| [`SRTO_ENFORCEDENCRYPTION`](#SRTO_ENFORCEDENCRYPTION) | 1.3.2 | pre | `bool` | | true | | W | GSD |
210210
| [`SRTO_EVENT`](#SRTO_EVENT) | | | `int32_t` | flags | | | R | S |
@@ -327,7 +327,7 @@ will be 10 times the value set with `SRTO_CONNTIMEO`.
327327

328328
| OptName | Since | Restrict | Type | Units | Default | Range | Dir | Entity |
329329
| ------------------ | --------- | -------- | --------- | ------ | -------- | ------ | --- | ------ |
330-
| `SRTO_CRYPTOMODE` | 1.6.0-dev | pre | `int32_t` | | 0 (Auto) | [0, 2] | RW | GSD |
330+
| `SRTO_CRYPTOMODE` | 1.5.2 | pre | `int32_t` | | 0 (Auto) | [0, 2] | RW | GSD |
331331

332332
The encryption mode to be used if the [`SRTO_PASSPHRASE`](#SRTO_PASSPHRASE) is set.
333333

docs/build/build-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,8 @@ use encryption for the connection.
275275

276276
When ON, the AEAD API is enabled. The `ENABLE_ENCRYPTION` must be enabled as well.
277277
The AEAD functionality is only available if OpenSSL EVP is selected as the crypto provider:
278-
build option `-DUSE_ENCLIB=openssl-evp`.
278+
build option should be set to `USE_ENCLIB=openssl-evp`.
279+
279280
The AEAD API is to be official in SRT v1.6.0.
280281

281282

srtcore/srt.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -646,7 +646,7 @@ enum SRT_KM_STATE
646646
SRT_KM_S_NOSECRET = 3, // Stream encrypted and no secret to decrypt Keying Material
647647
SRT_KM_S_BADSECRET = 4 // Stream encrypted and wrong secret is used, cannot decrypt Keying Material
648648
#ifdef ENABLE_AEAD_API_PREVIEW
649-
,SRT_KM_S_BADCRYPTOMODE = 5 // Stream encrypted but wrong cryptographic mode is used, cannot decrypt. Since v1.6.0.
649+
,SRT_KM_S_BADCRYPTOMODE = 5 // Stream encrypted but wrong cryptographic mode is used, cannot decrypt. Since v1.5.2.
650650
#endif
651651
};
652652

0 commit comments

Comments
 (0)