Skip to content

feat: add createDisplayMedia API #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brycetham merged 4 commits into from
Feb 4, 2025
Merged

feat: add createDisplayMedia API #88

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
377c902
feat: add createDisplayMedia API
brycetham Jan 31, 2025
ee85f18
chore: update constructor param names
brycetham Jan 31, 2025
de695d1
fix: redefine types in media/index.ts
brycetham Feb 3, 2025
a59db52
chore: change mockReturnValue to mockResolvedValue
brycetham Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 141 additions & 20 deletions src/device/device-management.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { WebrtcCoreError, WebrtcCoreErrorType } from '../errors';
import * as media from '../media';
import { LocalCameraStream } from '../media/local-camera-stream';
import { LocalDisplayStream } from '../media/local-display-stream';
Expand All @@ -7,14 +8,15 @@ import { createBrowserMock } from '../mocks/create-browser-mock';
import MediaStreamStub from '../mocks/media-stream-stub';
import { createMockedStream, createMockedStreamWithAudio } from '../util/test-utils';
import {
CaptureController,
createCameraAndMicrophoneStreams,
createCameraStream,
createDisplayMedia,
createDisplayStream,
createDisplayStreamWithAudio,
createMicrophoneStream,
getDevices,
} from './device-management';
import { WebrtcCoreError, WebrtcCoreErrorType } from '../errors';

jest.mock('../mocks/media-stream-stub');

Expand All @@ -25,9 +27,7 @@ describe('Device Management', () => {
const mockStream = createMockedStream();

describe('createMicrophoneStream', () => {
jest
.spyOn(media, 'getUserMedia')
.mockReturnValue(Promise.resolve(mockStream as unknown as MediaStream));
jest.spyOn(media, 'getUserMedia').mockReturnValue(Promise.resolve(mockStream));
Copy link

@SomeBody16 SomeBody16 Feb 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://jestjs.io/docs/mock-function-api#mockfnmockresolvedvaluevalue

mockFn.mockResolvedValue(value)

Shorthand for:

jest.fn().mockImplementation(() => Promise.resolve(value));

Copy link
Collaborator Author

@brycetham brycetham Feb 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


it('should call getUserMedia', async () => {
expect.assertions(1);
Expand Down Expand Up @@ -76,9 +76,7 @@ describe('Device Management', () => {
});

describe('createCameraStream', () => {
jest
.spyOn(media, 'getUserMedia')
.mockReturnValue(Promise.resolve(mockStream as unknown as MediaStream));
jest.spyOn(media, 'getUserMedia').mockReturnValue(Promise.resolve(mockStream));

it('should call getUserMedia', async () => {
expect.assertions(1);
Expand Down Expand Up @@ -125,9 +123,7 @@ describe('Device Management', () => {
});

describe('createCameraAndMicrophoneStreams', () => {
jest
.spyOn(media, 'getUserMedia')
.mockReturnValue(Promise.resolve(mockStream as unknown as MediaStream));
jest.spyOn(media, 'getUserMedia').mockReturnValue(Promise.resolve(mockStream));

it('should call getUserMedia', async () => {
expect.assertions(1);
Expand Down Expand Up @@ -173,24 +169,151 @@ describe('Device Management', () => {
});
});

describe('createDisplayMedia', () => {
jest.spyOn(media, 'getDisplayMedia').mockReturnValue(Promise.resolve(mockStream));

it('should call getDisplayMedia with video only', async () => {
expect.assertions(1);

await createDisplayMedia({
video: { displayStreamConstructor: LocalDisplayStream },
});
expect(media.getDisplayMedia).toHaveBeenCalledWith({ video: true, audio: false });
});

it('should call getDisplayMedia with both video and audio', async () => {
expect.assertions(1);

await createDisplayMedia({
video: { displayStreamConstructor: LocalDisplayStream },
audio: { systemAudioStreamConstructor: LocalSystemAudioStream },
});
expect(media.getDisplayMedia).toHaveBeenCalledWith({ video: true, audio: true });
});

it('should call getDisplayMedia with video and audio constraints', async () => {
expect.assertions(1);

await createDisplayMedia({
video: { displayStreamConstructor: LocalDisplayStream, constraints: { frameRate: 5 } },
audio: {
systemAudioStreamConstructor: LocalSystemAudioStream,
constraints: { autoGainControl: false },
},
});
expect(media.getDisplayMedia).toHaveBeenCalledWith({
video: { frameRate: 5 },
audio: { autoGainControl: false },
});
});

it('should preserve the content hint', async () => {
expect.assertions(1);

const [localDisplayStream] = await createDisplayMedia({
video: { displayStreamConstructor: LocalDisplayStream, videoContentHint: 'motion' },
});
expect(localDisplayStream.contentHint).toBe('motion');
});

it('should call getDisplayMedia with the preferCurrentTab option', async () => {
expect.assertions(1);

await createDisplayMedia({
video: { displayStreamConstructor: LocalDisplayStream, preferCurrentTab: true },
});
expect(media.getDisplayMedia).toHaveBeenCalledWith({
video: true,
audio: false,
preferCurrentTab: true,
});
});

it('should call getDisplayMedia with the selfBrowserSurface option', async () => {
expect.assertions(1);

await createDisplayMedia({
video: { displayStreamConstructor: LocalDisplayStream, selfBrowserSurface: 'include' },
});
expect(media.getDisplayMedia).toHaveBeenCalledWith({
video: true,
audio: false,
selfBrowserSurface: 'include',
});
});

it('should call getDisplayMedia with the surfaceSwitching option', async () => {
expect.assertions(1);

await createDisplayMedia({
video: { displayStreamConstructor: LocalDisplayStream, surfaceSwitching: 'include' },
});
expect(media.getDisplayMedia).toHaveBeenCalledWith({
video: true,
audio: false,
surfaceSwitching: 'include',
});
});

it('should call getDisplayMedia with the monitorTypeSurfaces option', async () => {
expect.assertions(1);

await createDisplayMedia({
video: { displayStreamConstructor: LocalDisplayStream, monitorTypeSurfaces: 'exclude' },
});
expect(media.getDisplayMedia).toHaveBeenCalledWith({
video: true,
audio: false,
monitorTypeSurfaces: 'exclude',
});
});

it('should call getDisplayMedia with the systemAudio option', async () => {
expect.assertions(1);

await createDisplayMedia({
video: { displayStreamConstructor: LocalDisplayStream },
audio: { systemAudioStreamConstructor: LocalSystemAudioStream, systemAudio: 'exclude' },
});
expect(media.getDisplayMedia).toHaveBeenCalledWith({
video: true,
audio: true,
systemAudio: 'exclude',
});
});

it('should call getDisplayMedia with the controller option', async () => {
expect.assertions(1);

const fakeController: CaptureController = {} as CaptureController;

await createDisplayMedia({
video: { displayStreamConstructor: LocalDisplayStream },
controller: fakeController,
});
expect(media.getDisplayMedia).toHaveBeenCalledWith({
video: true,
audio: false,
controller: fakeController,
});
});
});

describe('createDisplayStream', () => {
jest
.spyOn(media, 'getDisplayMedia')
.mockReturnValue(Promise.resolve(mockStream as unknown as MediaStream));
jest.spyOn(media, 'getDisplayMedia').mockReturnValue(Promise.resolve(mockStream));

it('should call getDisplayMedia', async () => {
expect.assertions(1);

await createDisplayStream(LocalDisplayStream);
expect(media.getDisplayMedia).toHaveBeenCalledWith({ video: true });
expect(media.getDisplayMedia).toHaveBeenCalledWith({ video: true, audio: false });
});

it('should return a LocalDisplayStream instance', async () => {
expect.assertions(2);
expect.assertions(1);

const localDisplayStream = await createDisplayStream(LocalDisplayStream);
expect(localDisplayStream).toBeInstanceOf(LocalDisplayStream);
expect(localDisplayStream.contentHint).toBeUndefined();
});

it('should preserve the content hint', async () => {
Expand All @@ -202,9 +325,7 @@ describe('Device Management', () => {
});

describe('createDisplayStreamWithAudio', () => {
jest
.spyOn(media, 'getDisplayMedia')
.mockReturnValue(Promise.resolve(mockStream as unknown as MediaStream));
jest.spyOn(media, 'getDisplayMedia').mockReturnValue(Promise.resolve(mockStream));

// This mock implementation is needed because createDisplayStreamWithAudio will create a new
// MediaStream from the video track of the mocked stream, so we need to make sure this new
Expand Down Expand Up @@ -235,7 +356,7 @@ describe('Device Management', () => {
const mockStreamWithAudio = createMockedStreamWithAudio();
jest
.spyOn(media, 'getDisplayMedia')
.mockReturnValueOnce(Promise.resolve(mockStreamWithAudio as unknown as MediaStream));
.mockReturnValueOnce(Promise.resolve(mockStreamWithAudio));

const [localDisplayStream, localSystemAudioStream] = await createDisplayStreamWithAudio(
LocalDisplayStream,
Expand Down
Loading