new pages
Some checks failed
Deploy Hugo site to Pages / build (push) Failing after 39s
Deploy Hugo site to Pages / deploy (push) Has been skipped

This commit is contained in:
2024-11-26 17:28:08 +00:00
parent 43f9a55f48
commit e7b0cbdbf6
34 changed files with 593 additions and 65 deletions

View File

@@ -0,0 +1,15 @@
---
title: Metadata
type: docs
prev: /user_docs/
weight: 2
---
It is possible to edit some of the metadata for the clips within Glympse.
Any metadata changes apply only to the Glympse database and are not carried over to the clips themselves.
To edit the metadata of the clips, click "Edit Clips" in the top right. This will look like the home page where you can select your production.
Click the Edit button to edit the clip metadata.
![Edit Metadata](/images/edit_metadata_select.png)

View File

@@ -0,0 +1,26 @@
---
title: Editing Metadata
type: docs
prev: /user_docs/
#next: /user_docs/Edit_Metadata/editing_metadata
---
When you click Edit on the metadata page you will be taken to the edit page. This shows a table with all the clips for that production. You can see whether a clip has been transcoded, is marked as hidden or edit the metadata of the clip(s)
![Edit Metadata](/images/edit_metadata.png)
There are limited options for editing the metadata. You can edit only the roll, the date and the shooter aswell as hide or unhide a clip.
To edit a clip select it by checking the checkbox of the clip row. At the bottom of the table you can enter a new roll/date/shooter then click save to save the edits.
Whatever you entered in all three boxes will be applied to the selected clips. Leave the box empty to leave the current details unchanged.
You can also hide/unhide clips by checking the hide checkbox. As soon as you click the checkbox it will be immediately hidden. It is possible that the clips may still appear until the cache has ben flushed. This process can take 10-15 minutes.
From this page you can also send multiple clips to the transcription engine.
Select the clips by checking the checkbox and click transcribe. This w3ill send the selected clips to be transcribed.
You can also delete clips from the Glympse database.
Glympse has read only access to the raw camera files, by deleting clips from Glympse, the original camera files will be unaffected.

View File

@@ -0,0 +1,24 @@
---
title: Watching Clips
type: docs
prev: /user_docs/
next: /user_docs/watch
weight: 1
---
![Home Page](/images/home.png)
Once You have been added to a production(s). You will see all your available productions on your home page. Under the thumbnail for each production you will see a list of buttons. The fist will let you view all the rushes from every shooter.
![All Rushes](/images/all_rushes.png)
Under that you will see a list of the shooters from that project. Clicking on these will allow you to filter the production by that shooter.
If we were to click on John Snow from either the home page or at the top of the rushes page. We will filter the rushes to show only those shot by John Snow.
![Shooter Filter](/images/shooter_filter.png)
At the top of the page, you can also click on the name of the shooter to filter the clips. Clicking on the shooter will only return results shot by the selected shooter. Clicking All or Reset will show all the rushes again.
In the search bar, you can search for a card or date. The results will be filtered live as you type.
Once you select a card, you'll be taken to the video player screen.

View File

@@ -0,0 +1,40 @@
---
title: Adding A Production
type: docs
prev: /user_docs/
weight: 3
---
To add a production click the "Add Production" button in the top right of the home page.
This will bring up the dialogue to add a new production.
![Add Production Modal](/images/add_production.png)
A production consists of two parts. The Base Production and the Production.
For example your Base Production may be "Game of Thrones" then the Production could be "Game of Thrones Series 1"
## Base Production
Select the Base Production, if it doesn't exist create it by clicking the button next to the select dropdown.
Enter the new name of your production and click submit.
![Add Production Base](/images/add_base.png)
The name you entered will be automatically selected.
## Production Series
Enter the series of the production you are adding. This must be an integer.
## Friendly Name
Enter a short friendly name for the series. This is what will appear on the default thumbnail. In this example we will enter `GOTS1`
## Select the location of the camera rushes.
Click on a directory to open it and select it by clicking the radio check mark on the left.
![Select Series](/images/series_select.png)
## Priority
Most productions can be left as the default of 20. But if you have a smaller production or one where the transcodes need to be run before others you can change the priority here. 0 = lowest priority 100 = highest priority.
## Production Owner
This is who will be responsible for the production. They will get the emails to say that the production has been scanned etc. This will usually be the edit assistant assigned to the project. The user must exist in the Glympse system.
If left empty, this will default to the admin user.
Click submit and the production will be added to Glympse and the Processing engine will start scanning for new clips.
![production Added](/images/production_added.png)

View File

@@ -0,0 +1,30 @@
---
title: User Settings
type: docs
prev: /user_docs/
weight: 4
---
From the User Settings menu you can change some personal settings.
![User Settings](/images/user_settings.png)
## Auto Add/Remove Tags
When checked, this will automatically add or remove tags on any related clips. When unchecked this, any tags you add or remove, will only be apply to the clips you have selected.
## Show Timecode Heading
This enables/disables the timecode box in the video player. Is is enabled by default, should you wish to disable it, you would do so here.
## Timecode Size
Default: 16
You can change the font size for the timecode box here. Increase to make the timecode larger, decrease to make it smaller.
## Reset Timecode Position
It is possible that the timecode box may disappear off the ege of the video player. Especially if you use multiple devices with different resolution screens. If that happens, you can reset it to the top left corner here.
## Auto Expand related clips
This will automatically expand the related clips accordion oin the right next to the player. If it is enabled, the related clips will be shown automatically. If disabled you would need to manually open the accordion to display them.
## Marker Colour
Change the colour of your markers, this only really applies to the Review section.
## Receive Admin Emails
If you are set as a production owner, this enables/disables the email updates.

View File

@@ -0,0 +1,126 @@
---
title: Watching clips
type: docs
prev: /user_docs/watch
weight: 2
---
![Watch Clips](/images/watch_clips.png)
This is where you will watch through the clips in Glympse.
When the page loads, it will automatically load the first clip into the player. To start playing you can press the big play button in the centre.
### The video Player
#### Timecode
Glympse uses the timecode from the media files. This is so that it matches the timecode that your editor sees within Avid or their NLE of choice.
*It is possible that the timecode in Glympse may be a frame off, this is because the timecodes must be calculated rather than read from the file. It will never be more that one frame off the timecode in the NLE.*
The timecode of the clip is displayed in two places. The seek bar:
![Timecode 1](/images/timecode1.png)
And there is a timecode box in the top left:
![Timecode 2](/images/timecode2.png)
This timecode box can be moved anywhere in the player window by dragging it to where you'd like it to be. You can reset the position of the timecode or disable the timecode box using the [user settings menu.](/user_docs/user_settings)
#### Audio Selection
For clips that have more than one track of audio, you can select the track to play back by clicking on the headphone icon on the playbar and selecting the audio track. Glympse by default creates a full mix of all the audio channels and plays this by default.
![Audio Tracks](/images/audio_select.png)
#### Theatre Mode
![Theatre Mode](/images/theatre_mode.png)
Clicking the theatre mode button will expand the player to take 100% the width of the browser window. Clicking the theatre mode button again will return the player back to its normal size.
#### Full Screen
Click this button for full screen playback
![Full Screen](/images/full_screen.png)
#### Rotate
Some clips like GoPro files can be the wrong orientation. Click the rotate button to rotate the clip by 180°
![Rotate](/images/rotate.png)
Click the restore rotate to return the clip to its original orientation.
![Restore Rotate](/images/restore_rotate.png)
#### Keyboard shortcuts
When on this page there are a number of keyboard shortcuts you can use.
J, K, L are shuttle controls to speed up or change the direction of play. You may have to click in the player window to enable these controls. Holding the Shift Key will also increase the amount the play is sped up or slowed down.
M will add a marker at the current time of the clip. Markers will appear for everyone who has access to the production.
### Selecting Clips
You can select the clip you'd like to view from the table at the bottom of the screen. Click the title of the clip to load it into the player.
You can also navigate through the clips by pressing the Next/Prev buttons at the bottom of the player. This will load the next or previous clip.
The title of the currently playing clip is shown at the bottom of the player and the middle of the menu bar at the top.
### Related Clips
When clips are loaded into Glympse, the system will scan for the start timecode and the end timecode of a clip. This allows it to show all the related clips of the clip you are playing. The related clips box onthe right of the player will update whenever the source of the video player changes. You can automatically hide or show the related clips dropdown using the [user settings menu.](/user_docs/user_settings)
In this example the clip being played belongs to the Main camera and there are two GoPro cameras that have clips with overlapping timecodes.
![Related](/images/related.png)
Clicking on the title of these related clips will play it in the current page, allowing you to quickly view clips from the other cameras. When you're viewing a related clip, the title in the menu bar and below the player will change showing you that it's playing a related clip then it will list the card followed by the clip title.
![Related](/images/related_clip.png)
As well as this, the prev/next buttons will disappear from below the player. You can select the next related clip by clicking on the clip title or you can return to the original clip by selecting it in the table at the bottom again. This will re-enable the next prev buttons and you can resume watching the camera clips as normal.
You can also navigate to any related cards from the related menu in the manu bar. This will show you camera cards from the same camera operator shot on the same day.
### Markers and Tags
You can add markers or tags to any clip within Glympse.
#### Markers
Markers allow you to mark a specific place in a clip. They will be displayed in the marker window next to the player and clicking on them will take you to the correct position in the clip.
Markers are shown to everyone who has access to the clip.
#### Tags
Tags are to tag an entire clip. You can tag more than one clip at a time. There is also a setting in the user settings menu that will automatically add the tags to any related clips.
Tags are available to everyone who has access to the clips.
## Menu Bar
![Menu](/images/menu.png)
The menu bar may show different options depending on what permissions you have. For example, the Download button will only appear if you have been give download permission for your production.
### File
From the file menu you can send a clip to be transcribed, edit the metadata of the card, submit the card for re-transcode or report issues with the card.
#### Transcribe
Select the clip or clips you would like to transcribe by checking the box in the table and click file then transcribe. This will send the selected clip(s) to the transcription engine. You can learn more about how this works [here.](/user_docs/transcription)
#### Edit metadata
From this menu you can change some of the metadata for the card. Anything you change here will be applied to every clip in the card.
You can change the date, the card name, or the shooter. You can also hide the card which will stop it from showing on the rushes page. Anyone with a link to the card would still be able to access the clips. This will *only* stop the card from appearing in the rushes page. Users with access to the production can also unhide any card from the metadata edit pages.
#### Request Retranscode
This will send the entire card back through the transcode engine. It allows you to report any issues with the card and manually submit the clips to the transcoder. The transcode will only work if the original clips are still available.
#### Report Issues
This allows you to report issues with the current card. But this option will not automatically retranscode the clips. They would need to be manually transcoded by the admin team.
### Related
This will show any cards that were shot by the same camera operator on the same day as the current card. Clicking one of these will take you load that current card.
### Download
If you have been given the download permissions for your production, you can download the original clip by selecting the clips from the table with the checkbox and clicking download. These files can be very large and may take a long time to download.
### Help
This will open these help pages.
### Settings
This will open the user settings menu. [Click here to learn more.](/user_docs/user_settings)
In the centre of the menu bar, the title of the currently loaded clip will be displayed.

View File

@@ -1,18 +1,8 @@
---
title: User Documentation
next: first-page
next: /user_docs/navigation
---
This is a demo of the theme's documentation layout.
Welcome to the user documentation of Glympse.
## Hello, World!
```go {filename="main.go"}
package main
import "fmt"
func main() {
fmt.Println("Hello, World!")
}
```
Glympse is designed to be as intuitive as possible, so hopefully you won't need to read this but its here if you need.