Skip to content

Commit

Permalink
Add warning about unreliable YouTube download
Browse files Browse the repository at this point in the history
  • Loading branch information
jwbonner committed Sep 3, 2023
1 parent 33c5957 commit 460b424
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/tabs/VIDEO.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ AdvantageScope provides three options for loading a video:
2. **YouTube:** Copy a YouTube link to the clipboard, then click the red clipboard icon. After a few seconds, the video will begin to download.
3. **The Blue Alliance:** Click the blue TBA icon to automatically load the match video based on the log file. If multiple videos are available, choose the video to download from the popup menu. This feature requires an API key for TBA, which should be obtained at [thebluealliance.com/account](https://www.thebluealliance.com/account) and copied to the AdvantageScope preferences page under "TBA API Key".

After choosing a video, the timeline on the bottom right begins turning blue to indicate the frames that have been cached (this step is necessary for smooth playback).
After choosing a video, the timeline on the bottom right begins turning blue to indicate the frames that have been cached (this step is necessary for smooth playback). This feature is intended for match-length videos only due to the frame conversion required.

> Note: This feature is intended for match-length videos. Due to the frame conversion required, loading a much longer video may have a negative impact on performance.
> Note: YouTube and TBA video download may failed unexpectedly due to changes on YouTube's servers. In case of issues, trying updating AdvantageScope or using a local video file instead.
![Loading a video](/docs/resources/video/video-1.gif)

Expand Down
4 changes: 2 additions & 2 deletions src/main/VideoProcessor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ export class VideoProcessor {
title: "Error",
message: "YouTube download failed",
detail:
"There was an error while trying to open the YouTube video. Please choose a local video file instead.",
"There was an error while trying to open the YouTube video. Please choose a local video file instead. Check the AdvantageScope video tab documentation for more information.",
icon: WINDOW_ICON
});
});
Expand All @@ -198,7 +198,7 @@ export class VideoProcessor {
title: "Error",
message: "YouTube download failed",
detail:
"There was an error while trying to open the match video from YouTube. Please choose a local video file instead.",
"There was an error while trying to open the match video from YouTube. Please choose a local video file instead. Check the AdvantageScope video tab documentation for more information.",
icon: WINDOW_ICON
});
});
Expand Down

0 comments on commit 460b424

Please sign in to comment.