Browse Source

Update hint texts and add links to documentation

pull/1886/head
Gabe Kangas 5 years ago
parent
commit
ee5e462c59
  1. 2
      web/components/config/cpu-usage.tsx
  2. 25
      web/components/config/video-variant-form.tsx
  3. 4
      web/pages/config-video.tsx
  4. 4
      web/styles/config-video-variants.scss

2
web/components/config/cpu-usage.tsx

@ -47,7 +47,7 @@ export default function CPUUsageSelector({ defaultValue, onChange }: Props) {
<div className="config-video-cpu-container"> <div className="config-video-cpu-container">
<Title level={3}>CPU Usage</Title> <Title level={3}>CPU Usage</Title>
<p className="description"> <p className="description">
There are trade-offs when considering CPU usage blah blah more wording here. Reduce the to improve server performance, or increase it to improve video quality.
</p> </p>
<div className="segment-slider-container"> <div className="segment-slider-container">
<Slider <Slider

25
web/components/config/video-variant-form.tsx

@ -16,7 +16,7 @@ const VIDEO_VARIANT_DEFAULTS = {
defaultValue: 24, defaultValue: 24,
unit: 'fps', unit: 'fps',
incrementBy: null, incrementBy: null,
tip: 'You prob wont need to touch this unless youre a hardcore gamer and need all the bitties', tip: 'Reducing your framerate will decrease the amount of video that needs to be encoded and sent to your viewers, saving CPU and bandwidth at the expense of smoothness. A lower value is generally is fine for most content.',
}, },
videoBitrate: { videoBitrate: {
min: 600, min: 600,
@ -24,7 +24,7 @@ const VIDEO_VARIANT_DEFAULTS = {
defaultValue: 1200, defaultValue: 1200,
unit: 'kbps', unit: 'kbps',
incrementBy: 100, incrementBy: 100,
tip: 'This is importatnt yo', tip: 'The overall quality of your stream is generally impacted most by bitrate.',
}, },
audioBitrate: { audioBitrate: {
min: 600, min: 600,
@ -117,9 +117,9 @@ export default function VideoVariantForm({
const selectedVideoBRnote = () => { const selectedVideoBRnote = () => {
let note = `Selected: ${dataState.videoBitrate}${videoBRUnit}`; let note = `Selected: ${dataState.videoBitrate}${videoBRUnit}`;
if (dataState.videoBitrate < 3000) { if (dataState.videoBitrate < 2000) {
note = `${note} - Good for low bandwidth environments.`; note = `${note} - Good for low bandwidth environments.`;
} else if (dataState.videoBitrate < 4500) { } else if (dataState.videoBitrate < 3500) {
note = `${note} - Good for most bandwidth environments.`; note = `${note} - Good for most bandwidth environments.`;
} else { } else {
note = `${note} - Good for high bandwidth environments.`; note = `${note} - Good for high bandwidth environments.`;
@ -150,9 +150,7 @@ export default function VideoVariantForm({
return ( return (
<div className="config-variant-form"> <div className="config-variant-form">
<p className="description"> <p className="description">
Say a thing here about how this all works. Read more{' '} <a href="https://owncast.online/docs/video">Learn more</a> about how each of these settings can impact the performance of your server.
<a href="https://owncast.online/docs/configuration/">here</a>. Click the OK button below to
save your information.
</p> </p>
<Row gutter={16}> <Row gutter={16}>
@ -163,6 +161,7 @@ export default function VideoVariantForm({
defaultValue={dataState.cpuUsageLevel} defaultValue={dataState.cpuUsageLevel}
onChange={handleVideoCpuUsageLevelChange} onChange={handleVideoCpuUsageLevelChange}
/> />
<p className="read-more-subtext"><a href="https://owncast.online/docs/video/#cpu-usage">Read more about CPU usage.</a></p>
</div> </div>
{/* VIDEO PASSTHROUGH FIELD - currently disabled */} {/* VIDEO PASSTHROUGH FIELD - currently disabled */}
@ -180,9 +179,8 @@ export default function VideoVariantForm({
<Col sm={24} md={12}> <Col sm={24} md={12}>
{/* VIDEO BITRATE FIELD */} {/* VIDEO BITRATE FIELD */}
<div <div
className={`form-module bitrate-container ${ className={`form-module bitrate-container ${dataState.videoPassthrough ? 'disabled' : ''
dataState.videoPassthrough ? 'disabled' : '' }`}
}`}
> >
<Typography.Title level={3}>Video Bitrate</Typography.Title> <Typography.Title level={3}>Video Bitrate</Typography.Title>
<p className="description">{VIDEO_VARIANT_DEFAULTS.videoBitrate.tip}</p> <p className="description">{VIDEO_VARIANT_DEFAULTS.videoBitrate.tip}</p>
@ -200,6 +198,7 @@ export default function VideoVariantForm({
/> />
<p className="selected-value-note">{selectedVideoBRnote()}</p> <p className="selected-value-note">{selectedVideoBRnote()}</p>
</div> </div>
<p className="read-more-subtext"><a href="https://owncast.online/docs/video/#bitrate">Read more about bitrates.</a></p>
</div> </div>
</Col> </Col>
</Row> </Row>
@ -207,8 +206,9 @@ export default function VideoVariantForm({
<Panel header="Advanced Settings" key="1"> <Panel header="Advanced Settings" key="1">
<p className="description"> <p className="description">
Resizing your content will take additional resources on your server. If you wish to Resizing your content will take additional resources on your server. If you wish to
optionally resize your output for this stream variant then you should either set the optionally resize your content for this stream output then you should either set the
width <strong>or</strong> the height to keep your aspect ratio. width <strong>or</strong> the height to keep your aspect ratio.{' '}
<a href="https://owncast.online/docs/video/#resolution">Read more about resolutions.</a>
</p> </p>
<TextField <TextField
@ -241,6 +241,7 @@ export default function VideoVariantForm({
/> />
<p className="selected-value-note">{selectedFramerateNote()}</p> <p className="selected-value-note">{selectedFramerateNote()}</p>
</div> </div>
<p className="read-more-subtext"><a href="https://owncast.online/docs/video/#framerate">Read more about framerates.</a></p>
</div> </div>
</Panel> </Panel>
</Collapse> </Collapse>

4
web/pages/config-video.tsx

@ -12,8 +12,8 @@ export default function ConfigVideoSettings() {
<Title>Video configuration</Title> <Title>Video configuration</Title>
<p className="description"> <p className="description">
Before changing your video configuration{' '} Before changing your video configuration{' '}
<a href="https://owncast.online/docs/encoding">visit the video documentation</a> to learn <a href="https://owncast.online/docs/video">visit the video documentation</a> to learn
how it impacts your stream performance. how it impacts your stream performance. The general rule is to start conservatively by having one middle quality stream output variant and experiment with adding more of varied qualities.
</p> </p>
<Row gutter={[16, 16]}> <Row gutter={[16, 16]}>

4
web/styles/config-video-variants.scss

@ -40,3 +40,7 @@
opacity: .8; opacity: .8;
} }
} }
.read-more-subtext {
font-size: 0.8rem;
}
Loading…
Cancel
Save