Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/millicast/millicast-sdk-interactivity
Interactivity SDK for Dolby Millicast built on top of the Millicast Web SDK to help bi-directional communication scenarios.
https://github.com/millicast/millicast-sdk-interactivity
api dolbyio interactivity millicast rts sdk webrtc
Last synced: 3 months ago
JSON representation
Interactivity SDK for Dolby Millicast built on top of the Millicast Web SDK to help bi-directional communication scenarios.
- Host: GitHub
- URL: https://github.com/millicast/millicast-sdk-interactivity
- Owner: millicast
- License: other
- Created: 2024-04-09T19:20:51.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-17T18:27:46.000Z (7 months ago)
- Last Synced: 2024-07-17T22:39:18.188Z (7 months ago)
- Topics: api, dolbyio, interactivity, millicast, rts, sdk, webrtc
- Language: TypeScript
- Homepage: https://millicast.github.io/millicast-sdk-interactivity/
- Size: 342 KB
- Stars: 3
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/millicast/millicast-sdk-interactivity/actions/workflows/build-package.yml)
[](https://github.com/millicast/millicast-sdk-interactivity/actions/workflows/build-documentation.yml)
[](https://github.com/millicast/millicast-sdk-interactivity/actions/workflows/publish-package.yml)
[](https://www.npmjs.com/package/@millicast/sdk-interactivity)
[](https://github.com/millicast/millicast-sdk-interactivity)
[](https://millicast.github.io/millicast-sdk-interactivity/)
# Dolby Millicast Interactivity SDK
This project is an SDK built on top of the [@millicast/sdk](https://github.com/millicast/millicast-sdk) library to provide an easier way to manage bi-directional communications on the [Dolby Millicast](https://dolby.io/) platform.
## Getting Started
To get started, install this SDK into your web application. The [@millicast/sdk](https://github.com/millicast/millicast-sdk) library will be installed as a dependency.
```bash
npm install @millicast/sdk-interactivity
```
To import this SDK via script, you will need to load the SDK as UMD as well as the Millicast SDK. An example is provided in the `example` folder of this repository.
```html
```
Then you can use the SDK using the variable `MillicastInteractivity`.
### Events
The SDK can trigger the following events:
- `publisherJoined` - Event triggered when a new publisher starts publishing to the stream.
- `publisherLeft` - Event triggered when a publisher stops publishing to the stream.
- `sourceAdded` - Event triggered when a new source is being published to the stream.
- `sourceRemoved` - Event triggered when a source stopped being published.
- `viewercount` - Event triggered from time to time to indicate the number of viewers connected to the stream.
```ts
import { Publisher, Room, Source } from '@millicast/sdk-interactivity';
const room = new Room({
streamName,
streamAccountId,
});
room.on('viewercount', (count: number) => console.log('Viewer count is', count));
room.on('sourceAdded', async (publisher: Publisher, source: Source) => {
const { identifier } = source;
console.log(`New ${identifier.sourceType} source: ${identifier.sourceName}`);
console.log(`is available from ${publisher.name}.`);
// Request to receive the source
await source.receive();
// Display the source on the UI
const videoElement = document.getElementById('video');
videoElement.srcObject = new MediaStream([source.videoTrack]);
videoElement.play();
});
```
### Connect to a stream
To publish your camera into a stream and listen to the available sources, call the `connect` function. Once connected, the SDK will trigger a series of `publisherJoined` and `sourceAdded` events that you must subscribe to in order to get the audio / video streams coming from the platform, and display them on your web page.
```ts
import { Publisher, Room, Source } from '@millicast/sdk-interactivity';
const room = new Room({
streamName,
streamAccountId,
});
room.on('publisherJoined', (publisher: Publisher) => {
console.log(`${publisher.name} joined.`);
});
room.on('sourceAdded', (publisher: Publisher, source: Source) => {
const { identifier } = source;
console.log(`New ${identifier.sourceType} source: ${identifier.sourceName}`);
console.log(`is available from ${publisher.name}.`);
});
// Let the SDK handle the getUserMedia
const publishedSource = await room.connect({
publishToken,
publisherName,
constraints: {
// Set WebRTC Media Stream constraints
audio: true,
video: true,
},
});
// If you want to provide your own media stream, use the following code
const customPublishedSource = await room.connect({
publishToken,
publisherName,
mediaStream,
});
// Stop publishing sources
room.unpublish(publishedSource);
room.unpublish(customPublishedSource);
```
### Watch to a stream
To watch a stream, call the `watch` function. Once connected, the SDK will trigger a series of `publisherJoined` and `sourceAdded` events that you must subscribe to in order to get the audio / video streams coming from the platform, and display them on your web page.
```ts
import { Publisher, Room, Source } from '@millicast/sdk-interactivity';
const room = new Room({
streamName,
streamAccountId,
});
room.on('publisherJoined', (publisher: Publisher) => {
console.log(`${publisher.name} joined.`);
});
room.on('sourceAdded', (publisher: Publisher, source: Source) => {
const { identifier } = source;
console.log(`New ${identifier.sourceType} source: ${identifier.sourceName}`);
console.log(`is available from ${publisher.name}.`);
});
await room.watch();
```
### Publish a new source to a stream
To publish another source into a stream, call the `publish` function.
```ts
// Will publish another source
await room.publish({
publishToken,
constraints: {
// Set WebRTC Media Stream constraints
audio: true,
video: true,
},
});
```
To publish a screenshare into the stream, call the [`getDisplayMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia) function to get the screenshare stream. and the `publish` function.
```ts
import { SourceType } from '@millicast/sdk-interactivity';
// Prompts the user to select and grant permission to capture the contents
// of a display or portion thereof (such as a window).
const mediaStream = await navigator.mediaDevices.getDisplayMedia({});
const source = await room.publish({
mediaStream,
releaseOnLeave: true,
publishToken,
sourceType: SourceType.Screenshare,
sourceName: 'My Screenshare',
});
// Display the screenshare on the page
const videoElement = document.getElementById('screenshare');
videoElement.srcObject = new MediaStream([source.videoTrack]);
videoElement.play();
```
## How to
The unit tests are built on [Jest](https://jestjs.io/), to execute the tests, run the following command.
```bash
npm run test
```
Create distribution package:
```bash
npm run build
```
The documentation is built on [TypeDoc](https://typedoc.org), to generate the doc, run the following command. You will find the HTML files in the `docs` folder.
```bash
npm run docs
```
You can also print the logs in the console and select the log level by using the following code.
```ts
import { Logger } from '@millicast/sdk-interactivity';
Logger.useDefaults({
defaultLevel: Logger.TRACE,
});
```
## Related Projects
- [Dolby.io WebRTC Statistics](https://github.com/DolbyIO/web-webrtc-stats)
- [Millicast SDK](https://github.com/millicast/millicast-sdk)
- [js-logger](https://github.com/jonnyreeves/js-logger)
- [TypeDoc](https://typedoc.org)
- [Jest](https://jestjs.io/)