# tlmeetingserver
> A simple video meeting library based on node.js and typescript
Latest version **0.0.3** (published 2024-06-04) · ISC license · 0 weekly downloads
## Install
```sh
npm install tlmeetingserver
pnpm add tlmeetingserver
yarn add tlmeetingserver
bun add tlmeetingserver
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.0.3 |
| Published | 2024-06-04 |
| First published | 2023-10-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 46.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | teamlinker |
| Maintainers | sx1989827 |
| Keywords | teamlinker, meeting, video, nodejs, typescript, meeting server |
## Links
- npm: https://www.npmjs.com/package/tlmeetingserver
- Repository: https://github.com/Teamlinker/Teamlinker
- Homepage: https://github.com/Teamlinker/Teamlinker/blob/dev/code/server/common/meeting/npm/README.md
- Issues: https://github.com/Teamlinker/Teamlinker/issues
- npm.io page: https://npm.io/package/tlmeetingserver
## Dependencies (2)
- [mediasoup](https://npm.io/package/mediasoup.md) ^3.14.1
- [socket.io](https://npm.io/package/socket.io.md) ^4.7.2
## Alternatives
- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads
## Recent versions
- 0.0.3 (latest) — 2024-06-04
- 0.0.2 — 2024-06-04
- 0.0.1 — 2023-10-09
## README
TLMeetingServer
A simple video meeting library based on node.js and typescript
This is server package,you can retrieve client package from here
## About
It is an open-source video meeting package of [Teamlinker](https://team-linker.com). It provides a variety of features to help users to build their own meeting rooms like these below:
## Features
1. Very easy to complete video meeting functionality
2. Support screen share,presenter management
3. mute & unmute
4. meeting chat
5. Free and open-source based on mediasoup
## Demo
[Teamlinker](https://team-linker.com)
Teamlinker provides a full experience of this package.Have a try!
## Installation
```shell
npm i tlmeetingserver
```
## Usage
TLMeetingServer is based on socket.io,you should build a socket.io connection from client and pass the io instance and meeting config to the TLMeetingServer construct function.
```typescript
let objMeeting=new MeetingServer(io,meetingConfig as any)
objMeeting.onJoinRoom=async (roomId,extraData, socketData, socketId) => {
try {
let objRoom=await MeetingRoomService.getItemById(roomId)
if(!objRoom) {
return {
businessId:null,
roomName:null,
error:"room not found"
}
} else if(objRoom.getItem().password!==extraData){
return {
businessId:null,
roomName:null,
error:"password wrong"
}
} else if(objRoom.getItem().organization_id!==socketData.organizationId) {
return {
businessId:null,
roomName:null,
error:"access forbidden"
}
} else {
return {
businessId:socketData.organizationUserId,
roomName:objRoom.getItem().name
}
}
} catch (err) {
console.error(err)
}
}
objMeeting.onJoinedRoom=async (roomId, businessId, socketId) => {
try {
let objRoom=await MeetingRoomService.getItemById(roomId)
if(objRoom) {
await objRoom.addMember(businessId)
emit.in(businessId).socketsJoin(roomId)
}
} catch(err) {
console.error(err)
}
}
objMeeting.onLeavedRoom=async (type, roomId, businessId) => {
try {
let objRoom=await MeetingRoomService.getItemById(roomId)
if(objRoom) {
await objRoom.removeMember(businessId)
emit.in(businessId).socketsLeave(roomId)
}
} catch(err) {
console.error(err)
}
}
objMeeting.onHandleOperation=async (type, roomId, fromBusinessId, toBusinessId, kind) => {
try {
let objRoom=await MeetingRoomService.getItemById(roomId)
if(objRoom) {
let ret=await objRoom.getPermission(fromBusinessId)
if(ret===ECommon_Meeting_Room_Permission.PRESENTER) {
return true;
}
} else {
return false
}
} catch(err) {
console.error(err)
return false
}
}
objMeeting.onDeleteRoom=async roomId => {
try {
await rpcContentApi.clearByRefId(roomId)
} catch (err) {
console.error(err)
}
}
objMeeting.onMessageSend=async (roomId, fromBusinessId, message) => {
try {
await rpcContentApi.add(roomId,ECommon_Model_Content_Type.MEETING_CHAT, fromBusinessId,message as string)
} catch (err) {
console.error(err)
}
}
await objMeeting.start()
```
### Meeting Config
```typescript
export default {
"worker": {
"logLevel": "warn",
"logTags": [
"info",
"ice",
"dtls",
"rtp",
"srtp",
"rtcp"
],
"rtcMinPort": 40000,
"rtcMaxPort": 49999
},
"codecs": [
{
"kind": "audio",
"mimeType": "audio/opus",
"clockRate": 48000,
"channels": 2
},
{
"kind": "video",
"mimeType": "video/VP8",
"clockRate": 90000,
"parameters": {
"x-google-start-bitrate": 1000
}
},
{
"kind": "video",
"mimeType": "video/VP9",
"clockRate": 90000,
"parameters": {
"profile-id": 2,
"x-google-start-bitrate": 1000
}
},
{
"kind": "video",
"mimeType": "video/h264",
"clockRate": 90000,
"parameters": {
"packetization-mode": 1,
"profile-level-id": "4d0032",
"level-asymmetry-allowed": 1,
"x-google-start-bitrate": 1000
}
},
{
"kind": "video",
"mimeType": "video/h264",
"clockRate": 90000,
"parameters": {
"packetization-mode": 1,
"profile-level-id": "42e01f",
"level-asymmetry-allowed": 1,
"x-google-start-bitrate": 1000
}
}
],
"webRtcTransport": {
"listenIps": [
{
"ip": "0.0.0.0",
"announcedIp": "192.168.110.6" //this ip should be the public ip
}
],
"enableUdp": true,
"enableTcp": true,
"preferUdp": true,
"enableSctp": false,
"initialAvailableOutgoingBitrate": 1000000,
"maxSctpMessageSize": 262144
}
}
```
## About Teamlinker
Teamlinker is a cooperation platform that integrates different kind of modules.You can contact your teammates,assign your tasks,start a meeting,schedule your events,manage your files and so on with Teamlinker.
---
_Source: https://npm.io/package/tlmeetingserver · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._