Skip to content

Commit d11627b

Browse files
committed
Update config documentation for media and script settings
1 parent 085040f commit d11627b

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/config.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,9 @@ multiple runs.`,
156156
arg: 'video-format',
157157
},
158158
useFakeMedia: {
159-
doc: `If true, the audio/video and screenshare will be generated using the browser fake device.`,
159+
doc: `If true, the audio/video/screenshare will be generated using the browser fake device.
160+
Otherwise, the audio and video streams will be captured from a video element attached to the page,
161+
while the screenshare will be captured from a new browser tab.`,
160162
format: 'Boolean',
161163
default: true,
162164
env: 'USE_FAKE_MEDIA',
@@ -382,7 +384,7 @@ on console. Regexp string allowed.`,
382384
scriptPath: {
383385
doc: `One or more JavaScript file paths (comma-separated). \
384386
If set, the files contents will be executed inside each opened tab page; \
385-
the following global variables will be attached to the \`window\` object: \
387+
the following global variables will be attached to the \`webrtcperf\` global object: \
386388
\`WEBRTC_PERF_SESSION\` the session number (0-indexed); \
387389
\`WEBRTC_PERF_TAB\` the tab number inside the same session (0-indexed); \
388390
\`WEBRTC_PERF_INDEX\` the page absolute index (0-indexed). \
@@ -410,7 +412,8 @@ the page context as \`webrtcperf.params\`.`,
410412
arg: 'disabled-video-codecs',
411413
},
412414
getDisplayMediaType: {
413-
doc: `The fake display type to use for \`getDisplayMedia\`. It could be \`monitor\`, \`window\` or \`browser\`,`,
415+
doc: `The fake display type to use for \`getDisplayMedia\` when \`useFakeMedia\` is \`true\`.
416+
It could be \`monitor\`, \`window\` or \`browser\`,`,
414417
format: String,
415418
default: 'monitor',
416419
env: 'GET_DISPLAY_MEDIA_TYPE',

0 commit comments

Comments
 (0)