• Stars
    star
    542
  • Rank 78,652 (Top 2 %)
  • Language
    TypeScript
  • License
    ISC License
  • Created almost 7 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

mediasoup client side JavaScript library

mediasoup-client v3

TypeScript client side library for building mediasoup based applications.

Website and Documentation

Support Forum

Usage Example

import { Device } from 'mediasoup-client';
import mySignaling from './my-signaling'; // Our own signaling stuff.

// Create a device (use browser auto-detection).
const device = new Device();

// Communicate with our server app to retrieve router RTP capabilities.
const routerRtpCapabilities = await mySignaling.request(
	'getRouterCapabilities'
);

// Load the device with the router RTP capabilities.
await device.load({ routerRtpCapabilities });

// Check whether we can produce video to the router.
if (!device.canProduce('video')) {
	console.warn('cannot produce video');

	// Abort next steps.
}

// Create a transport in the server for sending our media through it.
const { id, iceParameters, iceCandidates, dtlsParameters, sctpParameters } =
	await mySignaling.request('createTransport', {
		sctpCapabilities: device.sctpCapabilities,
	});

// Create the local representation of our server-side transport.
const sendTransport = device.createSendTransport({
	id,
	iceParameters,
	iceCandidates,
	dtlsParameters,
	sctpParameters,
});

// Set transport "connect" event handler.
sendTransport.on('connect', async ({ dtlsParameters }, callback, errback) => {
	// Here we must communicate our local parameters to our remote transport.
	try {
		await mySignaling.request('transport-connect', {
			transportId: sendTransport.id,
			dtlsParameters,
		});

		// Done in the server, tell our transport.
		callback();
	} catch (error) {
		// Something was wrong in server side.
		errback(error);
	}
});

// Set transport "produce" event handler.
sendTransport.on(
	'produce',
	async ({ kind, rtpParameters, appData }, callback, errback) => {
		// Here we must communicate our local parameters to our remote transport.
		try {
			const { id } = await mySignaling.request('produce', {
				transportId: sendTransport.id,
				kind,
				rtpParameters,
				appData,
			});

			// Done in the server, pass the response to our transport.
			callback({ id });
		} catch (error) {
			// Something was wrong in server side.
			errback(error);
		}
	}
);

// Set transport "producedata" event handler.
sendTransport.on(
	'producedata',
	async (
		{ sctpStreamParameters, label, protocol, appData },
		callback,
		errback
	) => {
		// Here we must communicate our local parameters to our remote transport.
		try {
			const { id } = await mySignaling.request('produceData', {
				transportId: sendTransport.id,
				sctpStreamParameters,
				label,
				protocol,
				appData,
			});

			// Done in the server, pass the response to our transport.
			callback({ id });
		} catch (error) {
			// Something was wrong in server side.
			errback(error);
		}
	}
);

// Produce our webcam video.
const stream = await navigator.mediaDevices.getUserMedia({ video: true });
const webcamTrack = stream.getVideoTracks()[0];
const webcamProducer = await sendTransport.produce({ track: webcamTrack });

// Produce data (DataChannel).
const dataProducer = await sendTransport.produceData({
	ordered: true,
	label: 'foo',
});

Authors

Social

Sponsor

You can support mediasoup by sponsoring it. Thanks!

License

ISC

More Repositories

1

mediasoup

Cutting Edge WebRTC Video Conferencing
C++
5,764
star
2

JsSIP

JsSIP, the JavaScript SIP library
JavaScript
2,316
star
3

mediasoup-demo

mediasoup official demo application
JavaScript
985
star
4

OverSIP

OverSIP: the SIP framework you dreamed about
C
343
star
5

libmediasoupclient

mediasoup client side C++ library
C++
270
star
6

protoo

Minimalist and extensible Node.js signaling framework for multi-party Real-Time applications
JavaScript
162
star
7

mediasoup-broadcaster-demo

mediasoup broadcaster demo (libmediasoupclient)
C++
96
star
8

tryit-jssip

New tryit-jssip application
JavaScript
80
star
9

mediasoup-client-aiortc

mediasoup-client handler for aiortc Python library
TypeScript
47
star
10

h264-profile-level-id

Utility to process H264 profile-level-id values
TypeScript
46
star
11

mediasoup-sdp-bridge

Node.js library to allow integration of SDP based clients with mediasoup
JavaScript
41
star
12

rtp.js

RTP stack for Node and browser written in TypeScript
TypeScript
40
star
13

awaitqueue

JavaScript utility to enqueue async tasks for Node.js and the browser
TypeScript
31
star
14

RetroRTC

WebRTC made retro.
JavaScript
22
star
15

jssip-node-websocket

JsSIP.Socket interface for the Node.js based on the websocket module
JavaScript
18
star
16

mediasoup-website

Website of mediasoup
SCSS
13
star
17

pick-port

Get a free TCP or UDP port for the given IP address
TypeScript
9
star
18

jssip.net

JsSIP website
JavaScript
9
star
19

oversip-mod-mysql

A MySQL connector module for OverSIP
Ruby
6
star
20

oversip-mod-postgresql

A PostgreSQL connector module for OverSIP
Ruby
5
star
21

TrendCalculator

An algorithm to ease off decreasing values based on a constant factor, an elapsed time and (probably) also on currently highest value seen
C++
1
star