@dtelecom/livekit-client 1.12.1
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.
- package/LICENSE +175 -0
- package/README.md +315 -0
- package/dist/@dtelecom/livekit-client.e2ee.worker.js +2 -0
- package/dist/@dtelecom/livekit-client.e2ee.worker.js.map +1 -0
- package/dist/@dtelecom/livekit-client.e2ee.worker.mjs +1633 -0
- package/dist/@dtelecom/livekit-client.e2ee.worker.mjs.map +1 -0
- package/dist/@dtelecom/livekit-client.esm.mjs +22545 -0
- package/dist/@dtelecom/livekit-client.esm.mjs.map +1 -0
- package/dist/@dtelecom/livekit-client.umd.js +2 -0
- package/dist/@dtelecom/livekit-client.umd.js.map +1 -0
- package/dist/@dtelecom/src/api/SignalClient.d.ts +102 -0
- package/dist/@dtelecom/src/api/SignalClient.d.ts.map +1 -0
- package/dist/@dtelecom/src/connectionHelper/ConnectionCheck.d.ts +26 -0
- package/dist/@dtelecom/src/connectionHelper/ConnectionCheck.d.ts.map +1 -0
- package/dist/@dtelecom/src/connectionHelper/checks/Checker.d.ts +59 -0
- package/dist/@dtelecom/src/connectionHelper/checks/Checker.d.ts.map +1 -0
- package/dist/@dtelecom/src/connectionHelper/checks/publishAudio.d.ts +6 -0
- package/dist/@dtelecom/src/connectionHelper/checks/publishAudio.d.ts.map +1 -0
- package/dist/@dtelecom/src/connectionHelper/checks/publishVideo.d.ts +6 -0
- package/dist/@dtelecom/src/connectionHelper/checks/publishVideo.d.ts.map +1 -0
- package/dist/@dtelecom/src/connectionHelper/checks/reconnect.d.ts +6 -0
- package/dist/@dtelecom/src/connectionHelper/checks/reconnect.d.ts.map +1 -0
- package/dist/@dtelecom/src/connectionHelper/checks/turn.d.ts +6 -0
- package/dist/@dtelecom/src/connectionHelper/checks/turn.d.ts.map +1 -0
- package/dist/@dtelecom/src/connectionHelper/checks/webrtc.d.ts +6 -0
- package/dist/@dtelecom/src/connectionHelper/checks/webrtc.d.ts.map +1 -0
- package/dist/@dtelecom/src/connectionHelper/checks/websocket.d.ts +6 -0
- package/dist/@dtelecom/src/connectionHelper/checks/websocket.d.ts.map +1 -0
- package/dist/@dtelecom/src/e2ee/E2eeManager.d.ts +47 -0
- package/dist/@dtelecom/src/e2ee/E2eeManager.d.ts.map +1 -0
- package/dist/@dtelecom/src/e2ee/KeyProvider.d.ts +44 -0
- package/dist/@dtelecom/src/e2ee/KeyProvider.d.ts.map +1 -0
- package/dist/@dtelecom/src/e2ee/constants.d.ts +15 -0
- package/dist/@dtelecom/src/e2ee/constants.d.ts.map +1 -0
- package/dist/@dtelecom/src/e2ee/errors.d.ts +11 -0
- package/dist/@dtelecom/src/e2ee/errors.d.ts.map +1 -0
- package/dist/@dtelecom/src/e2ee/index.d.ts +4 -0
- package/dist/@dtelecom/src/e2ee/index.d.ts.map +1 -0
- package/dist/@dtelecom/src/e2ee/types.d.ts +130 -0
- package/dist/@dtelecom/src/e2ee/types.d.ts.map +1 -0
- package/dist/@dtelecom/src/e2ee/utils.d.ts +24 -0
- package/dist/@dtelecom/src/e2ee/utils.d.ts.map +1 -0
- package/dist/@dtelecom/src/e2ee/worker/FrameCryptor.d.ts +176 -0
- package/dist/@dtelecom/src/e2ee/worker/FrameCryptor.d.ts.map +1 -0
- package/dist/@dtelecom/src/e2ee/worker/ParticipantKeyHandler.d.ts +65 -0
- package/dist/@dtelecom/src/e2ee/worker/ParticipantKeyHandler.d.ts.map +1 -0
- package/dist/@dtelecom/src/e2ee/worker/e2ee.worker.d.ts +2 -0
- package/dist/@dtelecom/src/e2ee/worker/e2ee.worker.d.ts.map +1 -0
- package/dist/@dtelecom/src/index.d.ts +38 -0
- package/dist/@dtelecom/src/index.d.ts.map +1 -0
- package/dist/@dtelecom/src/logger.d.ts +29 -0
- package/dist/@dtelecom/src/logger.d.ts.map +1 -0
- package/dist/@dtelecom/src/options.d.ts +104 -0
- package/dist/@dtelecom/src/options.d.ts.map +1 -0
- package/dist/@dtelecom/src/proto/livekit_models_pb.d.ts +1264 -0
- package/dist/@dtelecom/src/proto/livekit_models_pb.d.ts.map +1 -0
- package/dist/@dtelecom/src/proto/livekit_rtc_pb.d.ts +1373 -0
- package/dist/@dtelecom/src/proto/livekit_rtc_pb.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/DefaultReconnectPolicy.d.ts +8 -0
- package/dist/@dtelecom/src/room/DefaultReconnectPolicy.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/DeviceManager.d.ts +9 -0
- package/dist/@dtelecom/src/room/DeviceManager.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/PCTransport.d.ts +41 -0
- package/dist/@dtelecom/src/room/PCTransport.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/RTCEngine.d.ts +143 -0
- package/dist/@dtelecom/src/room/RTCEngine.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/ReconnectPolicy.d.ts +24 -0
- package/dist/@dtelecom/src/room/ReconnectPolicy.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/RegionUrlProvider.d.ts +17 -0
- package/dist/@dtelecom/src/room/RegionUrlProvider.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/Room.d.ts +248 -0
- package/dist/@dtelecom/src/room/Room.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/defaults.d.ts +8 -0
- package/dist/@dtelecom/src/room/defaults.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/errors.d.ts +43 -0
- package/dist/@dtelecom/src/room/errors.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/events.d.ts +477 -0
- package/dist/@dtelecom/src/room/events.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/participant/LocalParticipant.d.ts +177 -0
- package/dist/@dtelecom/src/room/participant/LocalParticipant.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/participant/Participant.d.ts +95 -0
- package/dist/@dtelecom/src/room/participant/Participant.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/participant/ParticipantTrackPermission.d.ts +26 -0
- package/dist/@dtelecom/src/room/participant/ParticipantTrackPermission.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/participant/RemoteParticipant.d.ts +55 -0
- package/dist/@dtelecom/src/room/participant/RemoteParticipant.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/participant/publishUtils.d.ts +28 -0
- package/dist/@dtelecom/src/room/participant/publishUtils.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/stats.d.ts +67 -0
- package/dist/@dtelecom/src/room/stats.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/timers.d.ts +13 -0
- package/dist/@dtelecom/src/room/timers.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/LocalAudioTrack.d.ts +25 -0
- package/dist/@dtelecom/src/room/track/LocalAudioTrack.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/LocalTrack.d.ts +78 -0
- package/dist/@dtelecom/src/room/track/LocalTrack.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/LocalTrackPublication.d.ts +38 -0
- package/dist/@dtelecom/src/room/track/LocalTrackPublication.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/LocalVideoTrack.d.ts +54 -0
- package/dist/@dtelecom/src/room/track/LocalVideoTrack.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/RemoteAudioTrack.d.ts +53 -0
- package/dist/@dtelecom/src/room/track/RemoteAudioTrack.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/RemoteTrack.d.ts +15 -0
- package/dist/@dtelecom/src/room/track/RemoteTrack.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/RemoteTrackPublication.d.ts +64 -0
- package/dist/@dtelecom/src/room/track/RemoteTrackPublication.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/RemoteVideoTrack.d.ts +56 -0
- package/dist/@dtelecom/src/room/track/RemoteVideoTrack.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/Track.d.ts +125 -0
- package/dist/@dtelecom/src/room/track/Track.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/TrackPublication.d.ts +72 -0
- package/dist/@dtelecom/src/room/track/TrackPublication.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/create.d.ts +24 -0
- package/dist/@dtelecom/src/room/track/create.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/facingMode.d.ts +41 -0
- package/dist/@dtelecom/src/room/track/facingMode.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/options.d.ts +272 -0
- package/dist/@dtelecom/src/room/track/options.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/processor/types.d.ts +19 -0
- package/dist/@dtelecom/src/room/track/processor/types.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/types.d.ts +24 -0
- package/dist/@dtelecom/src/room/track/types.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/track/utils.d.ts +27 -0
- package/dist/@dtelecom/src/room/track/utils.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/types.d.ts +26 -0
- package/dist/@dtelecom/src/room/types.d.ts.map +1 -0
- package/dist/@dtelecom/src/room/utils.d.ts +92 -0
- package/dist/@dtelecom/src/room/utils.d.ts.map +1 -0
- package/dist/@dtelecom/src/test/MockMediaStreamTrack.d.ts +26 -0
- package/dist/@dtelecom/src/test/MockMediaStreamTrack.d.ts.map +1 -0
- package/dist/@dtelecom/src/test/mocks.d.ts +12 -0
- package/dist/@dtelecom/src/test/mocks.d.ts.map +1 -0
- package/dist/@dtelecom/src/utils/AsyncQueue.d.ts +23 -0
- package/dist/@dtelecom/src/utils/AsyncQueue.d.ts.map +1 -0
- package/dist/@dtelecom/src/utils/browserParser.d.ts +12 -0
- package/dist/@dtelecom/src/utils/browserParser.d.ts.map +1 -0
- package/dist/@dtelecom/src/version.d.ts +3 -0
- package/dist/@dtelecom/src/version.d.ts.map +1 -0
- package/dist/ts4.2/@dtelecom/src/api/SignalClient.d.ts +105 -0
- package/dist/ts4.2/@dtelecom/src/connectionHelper/ConnectionCheck.d.ts +26 -0
- package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/Checker.d.ts +59 -0
- package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/publishAudio.d.ts +6 -0
- package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/publishVideo.d.ts +6 -0
- package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/reconnect.d.ts +6 -0
- package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/turn.d.ts +6 -0
- package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/webrtc.d.ts +6 -0
- package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/websocket.d.ts +6 -0
- package/dist/ts4.2/@dtelecom/src/e2ee/E2eeManager.d.ts +47 -0
- package/dist/ts4.2/@dtelecom/src/e2ee/KeyProvider.d.ts +44 -0
- package/dist/ts4.2/@dtelecom/src/e2ee/constants.d.ts +15 -0
- package/dist/ts4.2/@dtelecom/src/e2ee/errors.d.ts +11 -0
- package/dist/ts4.2/@dtelecom/src/e2ee/index.d.ts +4 -0
- package/dist/ts4.2/@dtelecom/src/e2ee/types.d.ts +130 -0
- package/dist/ts4.2/@dtelecom/src/e2ee/utils.d.ts +24 -0
- package/dist/ts4.2/@dtelecom/src/e2ee/worker/FrameCryptor.d.ts +176 -0
- package/dist/ts4.2/@dtelecom/src/e2ee/worker/ParticipantKeyHandler.d.ts +65 -0
- package/dist/ts4.2/@dtelecom/src/e2ee/worker/e2ee.worker.d.ts +2 -0
- package/dist/ts4.2/@dtelecom/src/index.d.ts +38 -0
- package/dist/ts4.2/@dtelecom/src/logger.d.ts +29 -0
- package/dist/ts4.2/@dtelecom/src/options.d.ts +104 -0
- package/dist/ts4.2/@dtelecom/src/proto/livekit_models_pb.d.ts +1264 -0
- package/dist/ts4.2/@dtelecom/src/proto/livekit_rtc_pb.d.ts +1373 -0
- package/dist/ts4.2/@dtelecom/src/room/DefaultReconnectPolicy.d.ts +8 -0
- package/dist/ts4.2/@dtelecom/src/room/DeviceManager.d.ts +9 -0
- package/dist/ts4.2/@dtelecom/src/room/PCTransport.d.ts +43 -0
- package/dist/ts4.2/@dtelecom/src/room/RTCEngine.d.ts +143 -0
- package/dist/ts4.2/@dtelecom/src/room/ReconnectPolicy.d.ts +24 -0
- package/dist/ts4.2/@dtelecom/src/room/RegionUrlProvider.d.ts +17 -0
- package/dist/ts4.2/@dtelecom/src/room/Room.d.ts +248 -0
- package/dist/ts4.2/@dtelecom/src/room/defaults.d.ts +8 -0
- package/dist/ts4.2/@dtelecom/src/room/errors.d.ts +43 -0
- package/dist/ts4.2/@dtelecom/src/room/events.d.ts +477 -0
- package/dist/ts4.2/@dtelecom/src/room/participant/LocalParticipant.d.ts +177 -0
- package/dist/ts4.2/@dtelecom/src/room/participant/Participant.d.ts +95 -0
- package/dist/ts4.2/@dtelecom/src/room/participant/ParticipantTrackPermission.d.ts +26 -0
- package/dist/ts4.2/@dtelecom/src/room/participant/RemoteParticipant.d.ts +55 -0
- package/dist/ts4.2/@dtelecom/src/room/participant/publishUtils.d.ts +28 -0
- package/dist/ts4.2/@dtelecom/src/room/stats.d.ts +67 -0
- package/dist/ts4.2/@dtelecom/src/room/timers.d.ts +13 -0
- package/dist/ts4.2/@dtelecom/src/room/track/LocalAudioTrack.d.ts +25 -0
- package/dist/ts4.2/@dtelecom/src/room/track/LocalTrack.d.ts +78 -0
- package/dist/ts4.2/@dtelecom/src/room/track/LocalTrackPublication.d.ts +38 -0
- package/dist/ts4.2/@dtelecom/src/room/track/LocalVideoTrack.d.ts +54 -0
- package/dist/ts4.2/@dtelecom/src/room/track/RemoteAudioTrack.d.ts +53 -0
- package/dist/ts4.2/@dtelecom/src/room/track/RemoteTrack.d.ts +15 -0
- package/dist/ts4.2/@dtelecom/src/room/track/RemoteTrackPublication.d.ts +64 -0
- package/dist/ts4.2/@dtelecom/src/room/track/RemoteVideoTrack.d.ts +56 -0
- package/dist/ts4.2/@dtelecom/src/room/track/Track.d.ts +125 -0
- package/dist/ts4.2/@dtelecom/src/room/track/TrackPublication.d.ts +72 -0
- package/dist/ts4.2/@dtelecom/src/room/track/create.d.ts +24 -0
- package/dist/ts4.2/@dtelecom/src/room/track/facingMode.d.ts +41 -0
- package/dist/ts4.2/@dtelecom/src/room/track/options.d.ts +280 -0
- package/dist/ts4.2/@dtelecom/src/room/track/processor/types.d.ts +19 -0
- package/dist/ts4.2/@dtelecom/src/room/track/types.d.ts +24 -0
- package/dist/ts4.2/@dtelecom/src/room/track/utils.d.ts +27 -0
- package/dist/ts4.2/@dtelecom/src/room/types.d.ts +26 -0
- package/dist/ts4.2/@dtelecom/src/room/utils.d.ts +92 -0
- package/dist/ts4.2/@dtelecom/src/test/MockMediaStreamTrack.d.ts +26 -0
- package/dist/ts4.2/@dtelecom/src/test/mocks.d.ts +12 -0
- package/dist/ts4.2/@dtelecom/src/utils/AsyncQueue.d.ts +23 -0
- package/dist/ts4.2/@dtelecom/src/utils/browserParser.d.ts +12 -0
- package/dist/ts4.2/@dtelecom/src/version.d.ts +3 -0
- package/package.json +102 -0
- package/src/api/SignalClient.ts +790 -0
- package/src/connectionHelper/ConnectionCheck.ts +90 -0
- package/src/connectionHelper/checks/Checker.ts +163 -0
- package/src/connectionHelper/checks/publishAudio.ts +33 -0
- package/src/connectionHelper/checks/publishVideo.ts +33 -0
- package/src/connectionHelper/checks/reconnect.ts +45 -0
- package/src/connectionHelper/checks/turn.ts +54 -0
- package/src/connectionHelper/checks/webrtc.ts +82 -0
- package/src/connectionHelper/checks/websocket.ts +27 -0
- package/src/e2ee/E2eeManager.ts +375 -0
- package/src/e2ee/KeyProvider.ts +78 -0
- package/src/e2ee/constants.ts +44 -0
- package/src/e2ee/errors.ts +16 -0
- package/src/e2ee/index.ts +3 -0
- package/src/e2ee/types.ts +161 -0
- package/src/e2ee/utils.ts +127 -0
- package/src/e2ee/worker/FrameCryptor.test.ts +19 -0
- package/src/e2ee/worker/FrameCryptor.ts +612 -0
- package/src/e2ee/worker/ParticipantKeyHandler.ts +175 -0
- package/src/e2ee/worker/e2ee.worker.ts +223 -0
- package/src/e2ee/worker/tsconfig.json +6 -0
- package/src/index.ts +85 -0
- package/src/logger.ts +64 -0
- package/src/options.ts +127 -0
- package/src/proto/livekit_models_pb.ts +2096 -0
- package/src/proto/livekit_rtc_pb.ts +2332 -0
- package/src/room/DefaultReconnectPolicy.ts +35 -0
- package/src/room/DeviceManager.ts +88 -0
- package/src/room/PCTransport.ts +452 -0
- package/src/room/RTCEngine.ts +1421 -0
- package/src/room/ReconnectPolicy.ts +27 -0
- package/src/room/RegionUrlProvider.ts +82 -0
- package/src/room/Room.test.ts +30 -0
- package/src/room/Room.ts +1907 -0
- package/src/room/defaults.ts +49 -0
- package/src/room/errors.ts +90 -0
- package/src/room/events.ts +535 -0
- package/src/room/participant/LocalParticipant.ts +1350 -0
- package/src/room/participant/Participant.ts +299 -0
- package/src/room/participant/ParticipantTrackPermission.ts +42 -0
- package/src/room/participant/RemoteParticipant.ts +359 -0
- package/src/room/participant/publishUtils.test.ts +189 -0
- package/src/room/participant/publishUtils.ts +399 -0
- package/src/room/stats.ts +136 -0
- package/src/room/timers.ts +16 -0
- package/src/room/track/LocalAudioTrack.ts +171 -0
- package/src/room/track/LocalTrack.ts +430 -0
- package/src/room/track/LocalTrackPublication.ts +87 -0
- package/src/room/track/LocalVideoTrack.test.ts +73 -0
- package/src/room/track/LocalVideoTrack.ts +513 -0
- package/src/room/track/RemoteAudioTrack.ts +248 -0
- package/src/room/track/RemoteTrack.ts +62 -0
- package/src/room/track/RemoteTrackPublication.ts +311 -0
- package/src/room/track/RemoteVideoTrack.test.ts +152 -0
- package/src/room/track/RemoteVideoTrack.ts +410 -0
- package/src/room/track/Track.ts +452 -0
- package/src/room/track/TrackPublication.ts +158 -0
- package/src/room/track/create.ts +143 -0
- package/src/room/track/facingMode.test.ts +31 -0
- package/src/room/track/facingMode.ts +103 -0
- package/src/room/track/options.ts +362 -0
- package/src/room/track/processor/types.ts +20 -0
- package/src/room/track/types.ts +25 -0
- package/src/room/track/utils.test.ts +111 -0
- package/src/room/track/utils.ts +183 -0
- package/src/room/types.ts +39 -0
- package/src/room/utils.test.ts +16 -0
- package/src/room/utils.ts +501 -0
- package/src/room/worker.d.ts +4 -0
- package/src/test/MockMediaStreamTrack.ts +84 -0
- package/src/test/mocks.ts +19 -0
- package/src/utils/AsyncQueue.test.ts +100 -0
- package/src/utils/AsyncQueue.ts +57 -0
- package/src/utils/browserParser.test.ts +88 -0
- package/src/utils/browserParser.ts +74 -0
- package/src/version.ts +4 -0
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
import DeviceManager from '../DeviceManager';
|
|
2
|
+
import { audioDefaults, videoDefaults } from '../defaults';
|
|
3
|
+
import { DeviceUnsupportedError, TrackInvalidError } from '../errors';
|
|
4
|
+
import { mediaTrackToLocalTrack } from '../participant/publishUtils';
|
|
5
|
+
import LocalAudioTrack from './LocalAudioTrack';
|
|
6
|
+
import type LocalTrack from './LocalTrack';
|
|
7
|
+
import LocalVideoTrack from './LocalVideoTrack';
|
|
8
|
+
import { Track } from './Track';
|
|
9
|
+
import { ScreenSharePresets } from './options';
|
|
10
|
+
import type {
|
|
11
|
+
AudioCaptureOptions,
|
|
12
|
+
CreateLocalTracksOptions,
|
|
13
|
+
ScreenShareCaptureOptions,
|
|
14
|
+
VideoCaptureOptions,
|
|
15
|
+
} from './options';
|
|
16
|
+
import {
|
|
17
|
+
constraintsForOptions,
|
|
18
|
+
mergeDefaultOptions,
|
|
19
|
+
screenCaptureToDisplayMediaStreamOptions,
|
|
20
|
+
} from './utils';
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Creates a local video and audio track at the same time. When acquiring both
|
|
24
|
+
* audio and video tracks together, it'll display a single permission prompt to
|
|
25
|
+
* the user instead of two separate ones.
|
|
26
|
+
* @param options
|
|
27
|
+
*/
|
|
28
|
+
export async function createLocalTracks(
|
|
29
|
+
options?: CreateLocalTracksOptions,
|
|
30
|
+
): Promise<Array<LocalTrack>> {
|
|
31
|
+
// set default options to true
|
|
32
|
+
options ??= {};
|
|
33
|
+
options.audio ??= true;
|
|
34
|
+
options.video ??= true;
|
|
35
|
+
|
|
36
|
+
const opts = mergeDefaultOptions(options, audioDefaults, videoDefaults);
|
|
37
|
+
const constraints = constraintsForOptions(opts);
|
|
38
|
+
|
|
39
|
+
// Keep a reference to the promise on DeviceManager and await it in getLocalDevices()
|
|
40
|
+
// works around iOS Safari Bug https://bugs.webkit.org/show_bug.cgi?id=179363
|
|
41
|
+
const mediaPromise = navigator.mediaDevices.getUserMedia(constraints);
|
|
42
|
+
|
|
43
|
+
if (options.audio) {
|
|
44
|
+
DeviceManager.userMediaPromiseMap.set('audioinput', mediaPromise);
|
|
45
|
+
mediaPromise.catch(() => DeviceManager.userMediaPromiseMap.delete('audioinput'));
|
|
46
|
+
}
|
|
47
|
+
if (options.video) {
|
|
48
|
+
DeviceManager.userMediaPromiseMap.set('videoinput', mediaPromise);
|
|
49
|
+
mediaPromise.catch(() => DeviceManager.userMediaPromiseMap.delete('videoinput'));
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
const stream = await mediaPromise;
|
|
53
|
+
return stream.getTracks().map((mediaStreamTrack) => {
|
|
54
|
+
const isAudio = mediaStreamTrack.kind === 'audio';
|
|
55
|
+
let trackOptions = isAudio ? options!.audio : options!.video;
|
|
56
|
+
if (typeof trackOptions === 'boolean' || !trackOptions) {
|
|
57
|
+
trackOptions = {};
|
|
58
|
+
}
|
|
59
|
+
let trackConstraints: MediaTrackConstraints | undefined;
|
|
60
|
+
const conOrBool = isAudio ? constraints.audio : constraints.video;
|
|
61
|
+
if (typeof conOrBool !== 'boolean') {
|
|
62
|
+
trackConstraints = conOrBool;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
// update the constraints with the device id the user gave permissions to in the permission prompt
|
|
66
|
+
// otherwise each track restart (e.g. mute - unmute) will try to initialize the device again -> causing additional permission prompts
|
|
67
|
+
if (trackConstraints) {
|
|
68
|
+
trackConstraints.deviceId = mediaStreamTrack.getSettings().deviceId;
|
|
69
|
+
} else {
|
|
70
|
+
trackConstraints = { deviceId: mediaStreamTrack.getSettings().deviceId };
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
const track = mediaTrackToLocalTrack(mediaStreamTrack, trackConstraints);
|
|
74
|
+
if (track.kind === Track.Kind.Video) {
|
|
75
|
+
track.source = Track.Source.Camera;
|
|
76
|
+
} else if (track.kind === Track.Kind.Audio) {
|
|
77
|
+
track.source = Track.Source.Microphone;
|
|
78
|
+
}
|
|
79
|
+
track.mediaStream = stream;
|
|
80
|
+
return track;
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* Creates a [[LocalVideoTrack]] with getUserMedia()
|
|
86
|
+
* @param options
|
|
87
|
+
*/
|
|
88
|
+
export async function createLocalVideoTrack(
|
|
89
|
+
options?: VideoCaptureOptions,
|
|
90
|
+
): Promise<LocalVideoTrack> {
|
|
91
|
+
const tracks = await createLocalTracks({
|
|
92
|
+
audio: false,
|
|
93
|
+
video: options,
|
|
94
|
+
});
|
|
95
|
+
return <LocalVideoTrack>tracks[0];
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
export async function createLocalAudioTrack(
|
|
99
|
+
options?: AudioCaptureOptions,
|
|
100
|
+
): Promise<LocalAudioTrack> {
|
|
101
|
+
const tracks = await createLocalTracks({
|
|
102
|
+
audio: options,
|
|
103
|
+
video: false,
|
|
104
|
+
});
|
|
105
|
+
return <LocalAudioTrack>tracks[0];
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Creates a screen capture tracks with getDisplayMedia().
|
|
110
|
+
* A LocalVideoTrack is always created and returned.
|
|
111
|
+
* If { audio: true }, and the browser supports audio capture, a LocalAudioTrack is also created.
|
|
112
|
+
*/
|
|
113
|
+
export async function createLocalScreenTracks(
|
|
114
|
+
options?: ScreenShareCaptureOptions,
|
|
115
|
+
): Promise<Array<LocalTrack>> {
|
|
116
|
+
if (options === undefined) {
|
|
117
|
+
options = {};
|
|
118
|
+
}
|
|
119
|
+
if (options.resolution === undefined) {
|
|
120
|
+
options.resolution = ScreenSharePresets.h1080fps15.resolution;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
if (navigator.mediaDevices.getDisplayMedia === undefined) {
|
|
124
|
+
throw new DeviceUnsupportedError('getDisplayMedia not supported');
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
const constraints = screenCaptureToDisplayMediaStreamOptions(options);
|
|
128
|
+
const stream: MediaStream = await navigator.mediaDevices.getDisplayMedia(constraints);
|
|
129
|
+
|
|
130
|
+
const tracks = stream.getVideoTracks();
|
|
131
|
+
if (tracks.length === 0) {
|
|
132
|
+
throw new TrackInvalidError('no video track found');
|
|
133
|
+
}
|
|
134
|
+
const screenVideo = new LocalVideoTrack(tracks[0], undefined, false);
|
|
135
|
+
screenVideo.source = Track.Source.ScreenShare;
|
|
136
|
+
const localTracks: Array<LocalTrack> = [screenVideo];
|
|
137
|
+
if (stream.getAudioTracks().length > 0) {
|
|
138
|
+
const screenAudio = new LocalAudioTrack(stream.getAudioTracks()[0], undefined, false);
|
|
139
|
+
screenAudio.source = Track.Source.ScreenShareAudio;
|
|
140
|
+
localTracks.push(screenAudio);
|
|
141
|
+
}
|
|
142
|
+
return localTracks;
|
|
143
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { describe, expect, test } from 'vitest';
|
|
2
|
+
import { facingModeFromDeviceLabel } from './facingMode';
|
|
3
|
+
|
|
4
|
+
describe('Test facingMode detection', () => {
|
|
5
|
+
test('OBS virtual camera should be detected.', () => {
|
|
6
|
+
const result = facingModeFromDeviceLabel('OBS Virtual Camera');
|
|
7
|
+
expect(result?.facingMode).toEqual('environment');
|
|
8
|
+
expect(result?.confidence).toEqual('medium');
|
|
9
|
+
});
|
|
10
|
+
|
|
11
|
+
test.each([
|
|
12
|
+
['Peter’s iPhone Camera', { facingMode: 'environment', confidence: 'medium' }],
|
|
13
|
+
['iPhone de Théo Camera', { facingMode: 'environment', confidence: 'medium' }],
|
|
14
|
+
])(
|
|
15
|
+
'Device labels that contain "iphone" should return facingMode "environment".',
|
|
16
|
+
(label, expected) => {
|
|
17
|
+
const result = facingModeFromDeviceLabel(label);
|
|
18
|
+
expect(result?.facingMode).toEqual(expected.facingMode);
|
|
19
|
+
expect(result?.confidence).toEqual(expected.confidence);
|
|
20
|
+
},
|
|
21
|
+
);
|
|
22
|
+
|
|
23
|
+
test.each([
|
|
24
|
+
['Peter’s iPad Camera', { facingMode: 'environment', confidence: 'medium' }],
|
|
25
|
+
['iPad de Théo Camera', { facingMode: 'environment', confidence: 'medium' }],
|
|
26
|
+
])('Device label that contain "ipad" should detect.', (label, expected) => {
|
|
27
|
+
const result = facingModeFromDeviceLabel(label);
|
|
28
|
+
expect(result?.facingMode).toEqual(expected.facingMode);
|
|
29
|
+
expect(result?.confidence).toEqual(expected.confidence);
|
|
30
|
+
});
|
|
31
|
+
});
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import log from 'loglevel';
|
|
2
|
+
import LocalTrack from './LocalTrack';
|
|
3
|
+
import type { VideoCaptureOptions } from './options';
|
|
4
|
+
|
|
5
|
+
type FacingMode = NonNullable<VideoCaptureOptions['facingMode']>;
|
|
6
|
+
type FacingModeFromLocalTrackOptions = {
|
|
7
|
+
/**
|
|
8
|
+
* If no facing mode can be determined, this value will be used.
|
|
9
|
+
* @defaultValue 'user'
|
|
10
|
+
*/
|
|
11
|
+
defaultFacingMode?: FacingMode;
|
|
12
|
+
};
|
|
13
|
+
type FacingModeFromLocalTrackReturnValue = {
|
|
14
|
+
/**
|
|
15
|
+
* The (probable) facingMode of the track.
|
|
16
|
+
* @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/facingMode | MDN docs on facingMode}
|
|
17
|
+
*/
|
|
18
|
+
facingMode: FacingMode;
|
|
19
|
+
/**
|
|
20
|
+
* The confidence that the returned facingMode is correct.
|
|
21
|
+
*/
|
|
22
|
+
confidence: 'high' | 'medium' | 'low';
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Try to analyze the local track to determine the facing mode of a track.
|
|
27
|
+
*
|
|
28
|
+
* @remarks
|
|
29
|
+
* There is no property supported by all browsers to detect whether a video track originated from a user- or environment-facing camera device.
|
|
30
|
+
* For this reason, we use the `facingMode` property when available, but will fall back on a string-based analysis of the device label to determine the facing mode.
|
|
31
|
+
* If both methods fail, the default facing mode will be used.
|
|
32
|
+
*
|
|
33
|
+
* @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/facingMode | MDN docs on facingMode}
|
|
34
|
+
* @experimental
|
|
35
|
+
*/
|
|
36
|
+
export function facingModeFromLocalTrack(
|
|
37
|
+
localTrack: LocalTrack | MediaStreamTrack,
|
|
38
|
+
options: FacingModeFromLocalTrackOptions = {},
|
|
39
|
+
): FacingModeFromLocalTrackReturnValue {
|
|
40
|
+
const track = localTrack instanceof LocalTrack ? localTrack.mediaStreamTrack : localTrack;
|
|
41
|
+
const trackSettings = track.getSettings();
|
|
42
|
+
let result: FacingModeFromLocalTrackReturnValue = {
|
|
43
|
+
facingMode: options.defaultFacingMode ?? 'user',
|
|
44
|
+
confidence: 'low',
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
// 1. Try to get facingMode from track settings.
|
|
48
|
+
if ('facingMode' in trackSettings) {
|
|
49
|
+
const rawFacingMode = trackSettings.facingMode;
|
|
50
|
+
log.debug('rawFacingMode', { rawFacingMode });
|
|
51
|
+
if (rawFacingMode && typeof rawFacingMode === 'string' && isFacingModeValue(rawFacingMode)) {
|
|
52
|
+
result = { facingMode: rawFacingMode, confidence: 'high' };
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
// 2. If we don't have a high confidence we try to get the facing mode from the device label.
|
|
57
|
+
if (['low', 'medium'].includes(result.confidence)) {
|
|
58
|
+
log.debug(`Try to get facing mode from device label: (${track.label})`);
|
|
59
|
+
const labelAnalysisResult = facingModeFromDeviceLabel(track.label);
|
|
60
|
+
if (labelAnalysisResult !== undefined) {
|
|
61
|
+
result = labelAnalysisResult;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
return result;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
const knownDeviceLabels = new Map<string, FacingModeFromLocalTrackReturnValue>([
|
|
69
|
+
['obs virtual camera', { facingMode: 'environment', confidence: 'medium' }],
|
|
70
|
+
]);
|
|
71
|
+
const knownDeviceLabelSections = new Map<string, FacingModeFromLocalTrackReturnValue>([
|
|
72
|
+
['iphone', { facingMode: 'environment', confidence: 'medium' }],
|
|
73
|
+
['ipad', { facingMode: 'environment', confidence: 'medium' }],
|
|
74
|
+
]);
|
|
75
|
+
/**
|
|
76
|
+
* Attempt to analyze the device label to determine the facing mode.
|
|
77
|
+
*
|
|
78
|
+
* @experimental
|
|
79
|
+
*/
|
|
80
|
+
export function facingModeFromDeviceLabel(
|
|
81
|
+
deviceLabel: string,
|
|
82
|
+
): FacingModeFromLocalTrackReturnValue | undefined {
|
|
83
|
+
const label = deviceLabel.trim().toLowerCase();
|
|
84
|
+
// Empty string is a valid device label but we can't infer anything from it.
|
|
85
|
+
if (label === '') {
|
|
86
|
+
return undefined;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
// Can we match against widely known device labels.
|
|
90
|
+
if (knownDeviceLabels.has(label)) {
|
|
91
|
+
return knownDeviceLabels.get(label);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
// Can we match against sections of the device label.
|
|
95
|
+
return Array.from(knownDeviceLabelSections.entries()).find(([section]) =>
|
|
96
|
+
label.includes(section),
|
|
97
|
+
)?.[1];
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
function isFacingModeValue(item: string): item is FacingMode {
|
|
101
|
+
const allowedValues: FacingMode[] = ['user', 'environment', 'left', 'right'];
|
|
102
|
+
return item === undefined || allowedValues.includes(item as FacingMode);
|
|
103
|
+
}
|
|
@@ -0,0 +1,362 @@
|
|
|
1
|
+
import type { Track } from './Track';
|
|
2
|
+
|
|
3
|
+
export interface TrackPublishDefaults {
|
|
4
|
+
/**
|
|
5
|
+
* encoding parameters for camera track
|
|
6
|
+
*/
|
|
7
|
+
videoEncoding?: VideoEncoding;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* @experimental
|
|
11
|
+
*/
|
|
12
|
+
backupCodec?: { codec: BackupVideoCodec; encoding: VideoEncoding } | false;
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* encoding parameters for screen share track
|
|
16
|
+
*/
|
|
17
|
+
screenShareEncoding?: VideoEncoding;
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* codec, defaults to vp8; for svc codecs, auto enable vp8
|
|
21
|
+
* as backup. (TBD)
|
|
22
|
+
*/
|
|
23
|
+
videoCodec?: VideoCodec;
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* max audio bitrate, defaults to [[AudioPresets.music]]
|
|
27
|
+
* @deprecated use `audioPreset` instead
|
|
28
|
+
*/
|
|
29
|
+
audioBitrate?: number;
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* which audio preset should be used for publishing (audio) tracks
|
|
33
|
+
* defaults to [[AudioPresets.music]]
|
|
34
|
+
*/
|
|
35
|
+
audioPreset?: AudioPreset;
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* dtx (Discontinuous Transmission of audio), enabled by default for mono tracks.
|
|
39
|
+
*/
|
|
40
|
+
dtx?: boolean;
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* red (Redundant Audio Data), enabled by default for mono tracks.
|
|
44
|
+
*/
|
|
45
|
+
red?: boolean;
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* publish track in stereo mode (or set to false to disable). defaults determined by capture channel count.
|
|
49
|
+
*/
|
|
50
|
+
forceStereo?: boolean;
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* use simulcast, defaults to true.
|
|
54
|
+
* When using simulcast, LiveKit will publish up to three versions of the stream
|
|
55
|
+
* at various resolutions.
|
|
56
|
+
*/
|
|
57
|
+
simulcast?: boolean;
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* scalability mode for svc codecs, defaults to 'L3T3'.
|
|
61
|
+
* for svc codecs, simulcast is disabled.
|
|
62
|
+
*/
|
|
63
|
+
scalabilityMode?: ScalabilityMode;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Up to two additional simulcast layers to publish in addition to the original
|
|
67
|
+
* Track.
|
|
68
|
+
* When left blank, it defaults to h180, h360.
|
|
69
|
+
* If a SVC codec is used (VP9 or AV1), this field has no effect.
|
|
70
|
+
*
|
|
71
|
+
* To publish three total layers, you would specify:
|
|
72
|
+
* {
|
|
73
|
+
* videoEncoding: {...}, // encoding of the primary layer
|
|
74
|
+
* videoSimulcastLayers: [
|
|
75
|
+
* VideoPresets.h540,
|
|
76
|
+
* VideoPresets.h216,
|
|
77
|
+
* ],
|
|
78
|
+
* }
|
|
79
|
+
*/
|
|
80
|
+
videoSimulcastLayers?: Array<VideoPreset>;
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* custom video simulcast layers for screen tracks
|
|
84
|
+
* Note: the layers need to be ordered from lowest to highest quality
|
|
85
|
+
*/
|
|
86
|
+
screenShareSimulcastLayers?: Array<VideoPreset>;
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* For local tracks, stop the underlying MediaStreamTrack when the track is muted (or paused)
|
|
90
|
+
* on some platforms, this option is necessary to disable the microphone recording indicator.
|
|
91
|
+
* Note: when this is enabled, and BT devices are connected, they will transition between
|
|
92
|
+
* profiles (e.g. HFP to A2DP) and there will be an audible difference in playback.
|
|
93
|
+
*
|
|
94
|
+
* defaults to false
|
|
95
|
+
*/
|
|
96
|
+
stopMicTrackOnMute?: boolean;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* Options when publishing tracks
|
|
101
|
+
*/
|
|
102
|
+
export interface TrackPublishOptions extends TrackPublishDefaults {
|
|
103
|
+
/**
|
|
104
|
+
* set a track name
|
|
105
|
+
*/
|
|
106
|
+
name?: string;
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Source of track, camera, microphone, or screen
|
|
110
|
+
*/
|
|
111
|
+
source?: Track.Source;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
export interface CreateLocalTracksOptions {
|
|
115
|
+
/**
|
|
116
|
+
* audio track options, true to create with defaults. false if audio shouldn't be created
|
|
117
|
+
* default true
|
|
118
|
+
*/
|
|
119
|
+
audio?: boolean | AudioCaptureOptions;
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* video track options, true to create with defaults. false if video shouldn't be created
|
|
123
|
+
* default true
|
|
124
|
+
*/
|
|
125
|
+
video?: boolean | VideoCaptureOptions;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
export interface VideoCaptureOptions {
|
|
129
|
+
/**
|
|
130
|
+
* A ConstrainDOMString object specifying a device ID or an array of device
|
|
131
|
+
* IDs which are acceptable and/or required.
|
|
132
|
+
*/
|
|
133
|
+
deviceId?: ConstrainDOMString;
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* a facing or an array of facings which are acceptable and/or required.
|
|
137
|
+
*/
|
|
138
|
+
facingMode?: 'user' | 'environment' | 'left' | 'right';
|
|
139
|
+
|
|
140
|
+
resolution?: VideoResolution;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
export interface ScreenShareCaptureOptions {
|
|
144
|
+
/**
|
|
145
|
+
* true to capture audio shared. browser support for audio capturing in
|
|
146
|
+
* screenshare is limited: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#browser_compatibility
|
|
147
|
+
*/
|
|
148
|
+
audio?: boolean | AudioCaptureOptions;
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* only allows for 'true' and chrome allows for additional options to be passed in
|
|
152
|
+
* https://developer.chrome.com/docs/web-platform/screen-sharing-controls/#displaySurface
|
|
153
|
+
*/
|
|
154
|
+
video?: true | { displaySurface?: 'window' | 'browser' | 'monitor' };
|
|
155
|
+
|
|
156
|
+
/** capture resolution, defaults to full HD */
|
|
157
|
+
resolution?: VideoResolution;
|
|
158
|
+
|
|
159
|
+
/** a CaptureController object instance containing methods that can be used to further manipulate the capture session if included. */
|
|
160
|
+
controller?: unknown; // TODO replace type with CaptureController once it lands in TypeScript
|
|
161
|
+
|
|
162
|
+
/** specifies whether the browser should allow the user to select the current tab for capture */
|
|
163
|
+
selfBrowserSurface?: 'include' | 'exclude';
|
|
164
|
+
|
|
165
|
+
/** specifies whether the browser should display a control to allow the user to dynamically switch the shared tab during screen-sharing. */
|
|
166
|
+
surfaceSwitching?: 'include' | 'exclude';
|
|
167
|
+
|
|
168
|
+
/** specifies whether the browser should include the system audio among the possible audio sources offered to the user */
|
|
169
|
+
systemAudio?: 'include' | 'exclude';
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* Experimental option to control whether the audio playing in a tab will continue to be played out of a user's
|
|
173
|
+
* local speakers when the tab is captured.
|
|
174
|
+
*/
|
|
175
|
+
suppressLocalAudioPlayback?: boolean;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
export interface AudioCaptureOptions {
|
|
179
|
+
/**
|
|
180
|
+
* specifies whether automatic gain control is preferred and/or required
|
|
181
|
+
*/
|
|
182
|
+
autoGainControl?: ConstrainBoolean;
|
|
183
|
+
|
|
184
|
+
/**
|
|
185
|
+
* the channel count or range of channel counts which are acceptable and/or required
|
|
186
|
+
*/
|
|
187
|
+
channelCount?: ConstrainULong;
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* A ConstrainDOMString object specifying a device ID or an array of device
|
|
191
|
+
* IDs which are acceptable and/or required.
|
|
192
|
+
*/
|
|
193
|
+
deviceId?: ConstrainDOMString;
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* whether or not echo cancellation is preferred and/or required
|
|
197
|
+
*/
|
|
198
|
+
echoCancellation?: ConstrainBoolean;
|
|
199
|
+
|
|
200
|
+
/**
|
|
201
|
+
* the latency or range of latencies which are acceptable and/or required.
|
|
202
|
+
*/
|
|
203
|
+
latency?: ConstrainDouble;
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* whether noise suppression is preferred and/or required.
|
|
207
|
+
*/
|
|
208
|
+
noiseSuppression?: ConstrainBoolean;
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* the sample rate or range of sample rates which are acceptable and/or required.
|
|
212
|
+
*/
|
|
213
|
+
sampleRate?: ConstrainULong;
|
|
214
|
+
|
|
215
|
+
/**
|
|
216
|
+
* sample size or range of sample sizes which are acceptable and/or required.
|
|
217
|
+
*/
|
|
218
|
+
sampleSize?: ConstrainULong;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
export interface AudioOutputOptions {
|
|
222
|
+
/**
|
|
223
|
+
* deviceId to output audio
|
|
224
|
+
*
|
|
225
|
+
* Only supported on browsers where `setSinkId` is available
|
|
226
|
+
*/
|
|
227
|
+
deviceId?: string;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
export interface VideoResolution {
|
|
231
|
+
width: number;
|
|
232
|
+
height: number;
|
|
233
|
+
frameRate?: number;
|
|
234
|
+
aspectRatio?: number;
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
export interface VideoEncoding {
|
|
238
|
+
maxBitrate: number;
|
|
239
|
+
maxFramerate?: number;
|
|
240
|
+
priority?: RTCPriorityType;
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
export class VideoPreset {
|
|
244
|
+
encoding: VideoEncoding;
|
|
245
|
+
|
|
246
|
+
width: number;
|
|
247
|
+
|
|
248
|
+
height: number;
|
|
249
|
+
|
|
250
|
+
constructor(
|
|
251
|
+
width: number,
|
|
252
|
+
height: number,
|
|
253
|
+
maxBitrate: number,
|
|
254
|
+
maxFramerate?: number,
|
|
255
|
+
priority?: RTCPriorityType,
|
|
256
|
+
) {
|
|
257
|
+
this.width = width;
|
|
258
|
+
this.height = height;
|
|
259
|
+
this.encoding = {
|
|
260
|
+
maxBitrate,
|
|
261
|
+
maxFramerate,
|
|
262
|
+
priority,
|
|
263
|
+
};
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
get resolution(): VideoResolution {
|
|
267
|
+
return {
|
|
268
|
+
width: this.width,
|
|
269
|
+
height: this.height,
|
|
270
|
+
frameRate: this.encoding.maxFramerate,
|
|
271
|
+
aspectRatio: this.width / this.height,
|
|
272
|
+
};
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
export interface AudioPreset {
|
|
277
|
+
maxBitrate: number;
|
|
278
|
+
priority?: RTCPriorityType;
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
const backupCodecs = ['vp8', 'h264'] as const;
|
|
282
|
+
|
|
283
|
+
export const videoCodecs = ['vp8', 'h264', 'vp9', 'av1'] as const;
|
|
284
|
+
|
|
285
|
+
export type VideoCodec = (typeof videoCodecs)[number];
|
|
286
|
+
|
|
287
|
+
export type BackupVideoCodec = (typeof backupCodecs)[number];
|
|
288
|
+
|
|
289
|
+
export function isBackupCodec(codec: string): codec is BackupVideoCodec {
|
|
290
|
+
return !!backupCodecs.find((backup) => backup === codec);
|
|
291
|
+
}
|
|
292
|
+
|
|
293
|
+
export function isCodecEqual(c1: string | undefined, c2: string | undefined): boolean {
|
|
294
|
+
return (
|
|
295
|
+
c1?.toLowerCase().replace(/audio\/|video\//y, '') ===
|
|
296
|
+
c2?.toLowerCase().replace(/audio\/|video\//y, '')
|
|
297
|
+
);
|
|
298
|
+
}
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* scalability modes for svc, only supprot l3t3 now.
|
|
302
|
+
*/
|
|
303
|
+
export type ScalabilityMode = 'L3T3' | 'L3T3_KEY';
|
|
304
|
+
|
|
305
|
+
export namespace AudioPresets {
|
|
306
|
+
export const telephone: AudioPreset = {
|
|
307
|
+
maxBitrate: 12_000,
|
|
308
|
+
};
|
|
309
|
+
export const speech: AudioPreset = {
|
|
310
|
+
maxBitrate: 20_000,
|
|
311
|
+
};
|
|
312
|
+
export const music: AudioPreset = {
|
|
313
|
+
maxBitrate: 32_000,
|
|
314
|
+
};
|
|
315
|
+
export const musicStereo: AudioPreset = {
|
|
316
|
+
maxBitrate: 48_000,
|
|
317
|
+
};
|
|
318
|
+
export const musicHighQuality: AudioPreset = {
|
|
319
|
+
maxBitrate: 64_000,
|
|
320
|
+
};
|
|
321
|
+
export const musicHighQualityStereo: AudioPreset = {
|
|
322
|
+
maxBitrate: 96_000,
|
|
323
|
+
};
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* Sane presets for video resolution/encoding
|
|
328
|
+
*/
|
|
329
|
+
export const VideoPresets = {
|
|
330
|
+
h90: new VideoPreset(160, 90, 60_000, 15),
|
|
331
|
+
h180: new VideoPreset(320, 180, 120_000, 15),
|
|
332
|
+
h216: new VideoPreset(384, 216, 180_000, 15),
|
|
333
|
+
h360: new VideoPreset(640, 360, 300_000, 20),
|
|
334
|
+
h540: new VideoPreset(960, 540, 600_000, 25),
|
|
335
|
+
h720: new VideoPreset(1280, 720, 1_700_000, 30),
|
|
336
|
+
h1080: new VideoPreset(1920, 1080, 3_000_000, 30),
|
|
337
|
+
h1440: new VideoPreset(2560, 1440, 5_000_000, 30),
|
|
338
|
+
h2160: new VideoPreset(3840, 2160, 8_000_000, 30),
|
|
339
|
+
} as const;
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* Four by three presets
|
|
343
|
+
*/
|
|
344
|
+
export const VideoPresets43 = {
|
|
345
|
+
h120: new VideoPreset(160, 120, 80_000, 15),
|
|
346
|
+
h180: new VideoPreset(240, 180, 100_000, 15),
|
|
347
|
+
h240: new VideoPreset(320, 240, 150_000, 15),
|
|
348
|
+
h360: new VideoPreset(480, 360, 225_000, 20),
|
|
349
|
+
h480: new VideoPreset(640, 480, 300_000, 20),
|
|
350
|
+
h540: new VideoPreset(720, 540, 450_000, 25),
|
|
351
|
+
h720: new VideoPreset(960, 720, 1_500_000, 30),
|
|
352
|
+
h1080: new VideoPreset(1440, 1080, 2_500_000, 30),
|
|
353
|
+
h1440: new VideoPreset(1920, 1440, 3_500_000, 30),
|
|
354
|
+
} as const;
|
|
355
|
+
|
|
356
|
+
export const ScreenSharePresets = {
|
|
357
|
+
h360fps3: new VideoPreset(640, 360, 200_000, 3, 'medium'),
|
|
358
|
+
h720fps5: new VideoPreset(1280, 720, 400_000, 5, 'medium'),
|
|
359
|
+
h720fps15: new VideoPreset(1280, 720, 1_000_000, 15, 'medium'),
|
|
360
|
+
h1080fps15: new VideoPreset(1920, 1080, 1_500_000, 15, 'medium'),
|
|
361
|
+
h1080fps30: new VideoPreset(1920, 1080, 3_000_000, 30, 'medium'),
|
|
362
|
+
} as const;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { Track } from '../Track';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @experimental
|
|
5
|
+
*/
|
|
6
|
+
export type ProcessorOptions<T extends Track.Kind> = {
|
|
7
|
+
kind: T;
|
|
8
|
+
track: MediaStreamTrack;
|
|
9
|
+
element?: HTMLMediaElement;
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* @experimental
|
|
14
|
+
*/
|
|
15
|
+
export interface TrackProcessor<T extends Track.Kind> {
|
|
16
|
+
name: string;
|
|
17
|
+
init: (opts: ProcessorOptions<T>) => void;
|
|
18
|
+
destroy: () => Promise<void>;
|
|
19
|
+
processedTrack?: MediaStreamTrack;
|
|
20
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type LocalAudioTrack from './LocalAudioTrack';
|
|
2
|
+
import type LocalVideoTrack from './LocalVideoTrack';
|
|
3
|
+
import type RemoteAudioTrack from './RemoteAudioTrack';
|
|
4
|
+
import type RemoteVideoTrack from './RemoteVideoTrack';
|
|
5
|
+
|
|
6
|
+
export type AudioTrack = RemoteAudioTrack | LocalAudioTrack;
|
|
7
|
+
export type VideoTrack = RemoteVideoTrack | LocalVideoTrack;
|
|
8
|
+
|
|
9
|
+
export type AdaptiveStreamSettings = {
|
|
10
|
+
/**
|
|
11
|
+
* Set a custom pixel density. Defaults to 2 for high density screens (3+) or
|
|
12
|
+
* 1 otherwise.
|
|
13
|
+
* When streaming videos on a ultra high definition screen this setting
|
|
14
|
+
* let's you account for the devicePixelRatio of those screens.
|
|
15
|
+
* Set it to `screen` to use the actual pixel density of the screen
|
|
16
|
+
* Note: this might significantly increase the bandwidth consumed by people
|
|
17
|
+
* streaming on high definition screens.
|
|
18
|
+
*/
|
|
19
|
+
pixelDensity?: number | 'screen';
|
|
20
|
+
/**
|
|
21
|
+
* If true, video gets paused when switching to another tab.
|
|
22
|
+
* Defaults to true.
|
|
23
|
+
*/
|
|
24
|
+
pauseVideoInBackground?: boolean;
|
|
25
|
+
};
|