ntgcalls 3.0.0-beta20 → 3.0.0-rc02

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +58 -41
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -14,6 +14,18 @@
14
14
  PyPi
15
15
  </a>
16
16
  •
17
+ <a href="https://www.npmjs.com/package/ntgcalls">
18
+ npm
19
+ </a>
20
+ •
21
+ <a href="https://crates.io/crates/ntgcalls">
22
+ crates.io
23
+ </a>
24
+ •
25
+ <a href="https://central.sonatype.com/artifact/io.github.pytgcalls/ntgcalls">
26
+ Maven Central
27
+ </a>
28
+ •
17
29
  <a href="https://github.com/pytgcalls/ntgcalls/releases">
18
30
  Releases
19
31
  </a>
@@ -27,12 +39,13 @@
27
39
  </a>
28
40
  </p>
29
41
 
30
- # NTgCalls [![PyPI - Version](https://img.shields.io/pypi/v/ntgcalls?logo=python&logoColor=%23959DA5&label=pypi&labelColor=%23282f37)](https://pypi.org/project/ntgcalls/) [![Downloads](https://img.shields.io/pepy/dt/ntgcalls?logoColor=%23959DA5&labelColor=%23282f37&color=%2328A745)](https://pepy.tech/project/ntgcalls)
42
+ # NTgCalls [![Release](https://img.shields.io/github/v/release/pytgcalls/ntgcalls?include_prereleases&logo=github&logoColor=%23959DA5&label=release&labelColor=%23282f37)](https://github.com/pytgcalls/ntgcalls/releases) [![PyPI - Downloads](https://img.shields.io/pepy/dt/ntgcalls?logo=python&logoColor=%23959DA5&label=pypi&labelColor=%23282f37&color=%2328A745)](https://pepy.tech/project/ntgcalls) [![npm - Downloads](https://img.shields.io/npm/dm/ntgcalls?logo=npm&logoColor=%23959DA5&label=npm&labelColor=%23282f37&color=%2328A745)](https://www.npmjs.com/package/ntgcalls) [![Crates.io - Downloads](https://img.shields.io/crates/d/ntgcalls?logo=rust&logoColor=%23959DA5&label=crates.io&labelColor=%23282f37&color=%2328A745)](https://crates.io/crates/ntgcalls)
43
+
31
44
  NTgCalls is a lightweight open-source library for media streaming in Telegram calls. Built from scratch in C++ with WebRTC & Boost, it prioritizes accessibility to developers and resource efficiency.
32
45
 
33
46
  | Powerful | Simple | Light |
34
47
  |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
35
- | <img src="https://raw.githubusercontent.com/pytgcalls/ntgcalls/master/.github/images/fast.gif" width=150 alt="Fast Logo"/><br>Built from scratch in C++ using Boost and libwebrtc | <img src="https://raw.githubusercontent.com/pytgcalls/ntgcalls/master/.github/images/simple.gif" width=150 alt="Simple Logo"/><br>Simple Python, GO, C Bindings and Java for Android SDK<br> | <img src="https://raw.githubusercontent.com/pytgcalls/ntgcalls/master/.github/images/light.gif" width=150 alt="Light logo"/><br>We removed anything that could burden the library, including <b>NodeJS</b> |
48
+ | <img src="https://raw.githubusercontent.com/pytgcalls/ntgcalls/master/.github/images/fast.gif" width=150 alt="Fast Logo"/><br>Built from scratch in C++ using Boost and libwebrtc | <img src="https://raw.githubusercontent.com/pytgcalls/ntgcalls/master/.github/images/simple.gif" width=150 alt="Simple Logo"/><br>Simple Python, Node.js, Rust, GO, C Bindings and Java for Android SDK<br> | <img src="https://raw.githubusercontent.com/pytgcalls/ntgcalls/master/.github/images/light.gif" width=150 alt="Light logo"/><br>We removed anything that could burden the library, keeping every binding a thin layer over the same native core |
36
49
 
37
50
  ## Build Status
38
51
  | Architecture | Windows | Linux | MacOS |
@@ -46,52 +59,56 @@ NTgCalls is a lightweight open-source library for media streaming in Telegram ca
46
59
  - Media controls: pause/resume and mute/unmute
47
60
  - Codec compatibility: H.264, HEVC (H.265), VP8, VP9, AV1, AAC, MP3, Opus
48
61
  - Content sharing: Screen streaming, Microphone and Camera streaming
49
- - Pre-built wheels for Python & AAR SDK library for Android
62
+ - Pre-built wheels for Python, npm packages for Node.js, crates for Rust & AAR SDK library for Android
63
+
64
+ ## Installing
65
+ Prebuilt packages are published for every supported language, so most users never need to compile anything.
66
+
67
+ | Language | Package | Install |
68
+ |:------------------|:-----------------------------------------------------------------------------------------------------|:---------------------------------|
69
+ | Python | [ntgcalls](https://pypi.org/project/ntgcalls/) | `pip install ntgcalls` |
70
+ | Node.js | [ntgcalls](https://www.npmjs.com/package/ntgcalls) | `npm install ntgcalls` |
71
+ | Rust | [ntgcalls](https://crates.io/crates/ntgcalls) | `cargo add ntgcalls` |
72
+ | Java (Android) | [io.github.pytgcalls:ntgcalls](https://central.sonatype.com/artifact/io.github.pytgcalls/ntgcalls) | Gradle dependency |
73
+ | C, C++ and Go | [Release archives](https://github.com/pytgcalls/ntgcalls/releases) | Download the shared or static zip |
74
+
75
+ ## Building from source
76
+ Prerequisites are listed in the
77
+ [Build Guide](https://pytgcalls.github.io/NTgCalls/Build%20Guide#Installing=Prerequisites).
78
+ All commands are run from the root of the repository.
79
+
80
+ | Target | Command | Output |
81
+ |:-------------|:-------------------------------------------|:-------------------------------------------|
82
+ | Python | `python3 setup.py install` | Installed in the current environment |
83
+ | Node.js | `python3 setup.py build_lib --target=node` | `targets/node/build/Release/ntgcalls.node` |
84
+ | C and C++ | `python3 setup.py build_lib` | `shared-output` and `static-output` |
85
+
86
+ The C target builds both the shared and the static library in a single run. Each output directory also
87
+ contains an `include` folder with the headers to add to your project.
50
88
 
51
- ## Compiling
89
+ The Rust bindings do not build the native library: the `ntgcalls-sys` build script downloads the matching
90
+ static libraries from the GitHub release for your platform. Set `NTGCALLS_RELEASE_BASE` to build against a
91
+ local release instead.
52
92
 
53
- ### Python Bindings
54
- NTgCalls includes Python bindings for seamless integration. Follow these steps to compile it with Python Bindings:
55
- 1. Ensure you are in the root directory of the NTgCalls project.
56
- 2. Run the following command to install the Py Bindings:
93
+ <details>
94
+ <summary><b>Using the library from Go</b></summary>
57
95
 
58
- ```shell
59
- python3 setup.py install
60
- ```
61
- ### Go Bindings
62
96
  > [!WARNING]
63
97
  > Static linking for Windows is not supported yet since our library is built with MSVC and Go uses MinGW for static linking.
64
98
  > More info can be found [here](https://github.com/golang/go/issues/63903)
65
99
 
66
- NTgCalls includes Go Bindings, enabling seamless integration with Go. Follow these steps to compile it with Go Bindings:
67
- 1. There is an example project for Go in `./examples/go/` directory, ensure you are in that directory
68
- 2. Prerequisites for building are the same as for building a library itself and can be found [here](https://pytgcalls.github.io/NTgCalls/Build%20Guide#Installing=Prerequisites)
69
- 3. Download **shared** or **static** release of the library from https://github.com/pytgcalls/ntgcalls/releases
70
- 4. Copy `ntgcalls.h` file into `./examples/go/ntgcalls/` directory
71
- 5. The rest of the files should be copied to `./examples/go/` directory
72
- * `ntgcalls.dll` or `ntgcalls.lib` files in case of Windows amd64
73
- * `libntgcalls.so` or `libntgcalls.a` files in case of Linux amd64
74
- * `libntgcalls.dylib` or `libntgcalls.a` files in case of macOS
75
- 6. Then in `./examples/go/` directory run `go build` or `go run .` with CGO_ENABLED=1 env variable set
76
- * `$env:CGO_ENABLED=1; go run .` for Windows PowerShell
77
- * `CGO_ENABLED=1 go run .` for UNIX
78
-
79
-
80
- ### C Bindings
81
- For developers looking to use NTgCalls with C and C++, we provide C Bindings. Follow these steps to compile it with C Bindings:
82
- 1. Ensure you are in the root directory of the NTgCalls project.
83
- 2. Run the following command to generate the library:
84
- ```shell
85
- # Static library
86
- python3 setup.py build_lib --static
87
-
88
- # Shared library
89
- python3 setup.py build_lib --shared
90
- ```
91
- 3. Upon successful execution, a library will be generated in the "shared-output" or "static-output" directory, depending on the chosen option.
92
- Now you can use this library to develop applications with NTgCalls.
93
- 4. To include the necessary headers in your C/C++ projects, you will find the "include" folder in the "shared-output" or "static-output" directory.
94
- Use this folder by including the required header files.
100
+ Go consumes the C bindings through an example project in `./examples/go/`:
101
+ 1. Download the **shared** or **static** release from the [Releases](https://github.com/pytgcalls/ntgcalls/releases) page
102
+ 2. Copy `ntgcalls.h` into `./examples/go/ntgcalls/`
103
+ 3. Copy the remaining files into `./examples/go/`
104
+ * `ntgcalls.dll` or `ntgcalls.lib` on Windows amd64
105
+ * `libntgcalls.so` or `libntgcalls.a` on Linux amd64
106
+ * `libntgcalls.dylib` or `libntgcalls.a` on macOS
107
+ 4. Run `go build` or `go run .` with `CGO_ENABLED=1`
108
+ * `$env:CGO_ENABLED=1; go run .` on Windows PowerShell
109
+ * `CGO_ENABLED=1 go run .` on UNIX
110
+
111
+ </details>
95
112
 
96
113
  ## Key Contributors
97
114
  * <b><a href="https://github.com/Laky-64">@Laky-64</a> (DevOps Engineer, Software Architect, Porting Engineer):</b>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ntgcalls",
3
- "version": "3.0.0-beta20",
3
+ "version": "3.0.0-rc02",
4
4
  "description": "A Library for creating group calls and P2P calls with WebRTC and MTProto",
5
5
  "keywords": [
6
6
  "telegram",
@@ -44,10 +44,10 @@
44
44
  "build": "cmake-js compile"
45
45
  },
46
46
  "optionalDependencies": {
47
- "@ntgcalls/linux-x64": "3.0.0-beta20",
48
- "@ntgcalls/linux-arm64": "3.0.0-beta20",
49
- "@ntgcalls/darwin-arm64": "3.0.0-beta20",
50
- "@ntgcalls/win32-x64": "3.0.0-beta20"
47
+ "@ntgcalls/linux-x64": "3.0.0-rc02",
48
+ "@ntgcalls/linux-arm64": "3.0.0-rc02",
49
+ "@ntgcalls/darwin-arm64": "3.0.0-rc02",
50
+ "@ntgcalls/win32-x64": "3.0.0-rc02"
51
51
  },
52
52
  "devDependencies": {
53
53
  "@types/node": "^26.1.1",