restructure project settings category

This commit is contained in:
Milan Kolar 2021-04-30 09:47:08 +02:00
parent ebc2097ebe
commit 27f6546edd
7 changed files with 76 additions and 72 deletions

View file

@ -1,71 +0,0 @@
---
id: admin_settings_project
title: Project Settings
sidebar_label: Project Settings
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Project settings can have project specific values. Each new project is using studio values defined in **default** project but these values can be modified or overriden per project.
:::warning Default studio values
Project is always using default project values if is not overriding them with own values. Any changes in default project may affect all existing projects.
:::
## Global
### Publish plugins
Publish plugins used across all integrations.
#### ExtractReview
Plugin responsible for automatic FFmpeg conversion to variety of formats.
Extract review is using profile filtering to be able render different outputs for different situations.
**Profile filters**
You can define multiple profiles for different contexts. Profile with filters matching current context the most is used. You can define profile without filters and use it as **default**. Only **one or none** profile is processed per instance.
All context filters are lists which may contain strings or Regular expressions (RegEx).
- **hosts** - Host from which publishing was triggered. `["maya", "nuke"]`
- **families** - Main family of processed instance. `["plate", "model"]`
:::important Filtering
Filters are optional and may not be set. In case when multiple profiles match current context, profile with filters has higher priority that profile without filters.
:::
![global_extract_review_profiles](assets/settings/global_extract_review_profiles.png)
**Output Definitions**
Profile may have multiple outputs from one input. Each output must have defined unique name and output extension (use extension without dot e.g. **mp4**). All other settings of output definition are optional.
![global_extract_review_output_defs](assets/settings/global_extract_review_output_defs.png)
- **Tags**
Define what will happen to output.
- **FFmpeg arguments**
These arguments are appended to ffmpeg arguments auto generated by publish plugin. Some of arguments are handled automatically like rescaling or letterboxes.
- **Video filters** additional FFmpeg filters that would be defined in `-filter:v` or `-vf` command line arguments
- **Audio filters** additional FFmpeg filters that would be defined in `-filter:a` or `-af` command line arguments
- **Input arguments** input definition arguments of video or image sequence - this setting has limitations as you have to know what is input
- **Output arguments** other FFmpeg output arguments like codec definition
- **Output width** and **Output height**
- it is possible to rescale output to specified resolution and keep aspect ratio
- both values must have value higher than 0
- **Letter Box**
- **Enabled** - Enable letter boxes
- **Ratio** - Ratio of letter boxes
- **Type** - **Letterbox** or **Pillarbox**
- **Fill color** - Fill color of boxes (RGBA: 0-255)
- **Line Thickness** - Line thickness on the edge of box (set to `0` to turn off)
- **Fill color** - Line color on the edge of box (RGBA: 0-255)
- **Example**
![gobal_extract_review_letter_box_settings](assets/settings/gobal_extract_review_letter_box_settings.png)
![gobal_extract_review_letter_box](assets/settings/gobal_extract_review_letter_box.png)

View file

Before

Width:  |  Height:  |  Size: 1.2 MiB

After

Width:  |  Height:  |  Size: 1.2 MiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Before After
Before After

View file

@ -0,0 +1,69 @@
---
id: settings_project_global
title: Project Global Setting
sidebar_label: Global
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Project settings can have project specific values. Each new project is using studio values defined in **default** project but these values can be modified or overriden per project.
:::warning Default studio values
Projects always use default project values unless they have [project override](../admin_settings#project-overrides) (orage colour). Any changes in default project may affect all existing projects.
:::
## Publish plugins
Publish plugins used across all integrations.
### Extract Review
Plugin responsible for automatic FFmpeg conversion to variety of formats.
Extract review is using profile filtering to be able render different outputs for different situations.
**Profile filters**
You can define multiple profiles for different contexts. Profile with filters matching the current context the most, is used. You can define profile without filters and use it as **default**. Only **one or none** profile will be processed per instance.
All context filters are lists which may contain strings or Regular expressions (RegEx).
- **`hosts`** - Host from which publishing was triggered. `["maya", "nuke"]`
- **`families`** - Main family of processed instance. `["plate", "model"]`
:::important Filtering
Filters are optional. In case when multiple profiles match current context, profile with higher number of matched filters has higher priority that profile without filters.
:::
![global_extract_review_profiles](assets/global_extract_review_profiles.png)
**Output Definitions**
Profile may generate multiple outputs from a single input. Each output must define unique name and output extension (use the extension without a dot e.g. **mp4**). All other settings of output definition are optional.
![global_extract_review_output_defs](assets/global_extract_review_output_defs.png)
- **`Tags`**
Define what will happen to output.
- **`FFmpeg arguments`**
These arguments are appended to ffmpeg arguments auto generated by publish plugin. Some of arguments are handled automatically like rescaling or letterboxes.
- **Video filters** additional FFmpeg filters that would be defined in `-filter:v` or `-vf` command line arguments.
- **Audio filters** additional FFmpeg filters that would be defined in `-filter:a` or `-af` command line arguments.
- **Input arguments** input definition arguments of video or image sequence - this setting has limitations as you have to know what is input.
- **Output arguments** other FFmpeg output arguments like codec definition.
- **`Output width`** and **`Output height`**
- it is possible to rescale output to specified resolution and keep aspect ratio.
- If value is set to 0, source resolution will be used.
- **`Letter Box`**
- **Enabled** - Enable letter boxes
- **Ratio** - Ratio of letter boxes
- **Type** - **Letterbox** (horizontal bars) or **Pillarbox** (vertical bars)
- **Fill color** - Fill color of boxes (RGBA: 0-255)
- **Line Thickness** - Line thickness on the edge of box (set to `0` to turn off)
- **Fill color** - Line color on the edge of box (RGBA: 0-255)
- **Example**
![global_extract_review_letter_box_settings](assets/global_extract_review_letter_box_settings.png)
![global_extract_review_letter_box](assets/global_extract_review_letter_box.png)

View file

@ -57,7 +57,13 @@ module.exports = {
"admin_settings",
"admin_settings_system",
"admin_settings_project_anatomy",
"admin_settings_project",
{
type: "category",
label: "Project Settings",
items: [
"project_settings/settings_project_global"
],
},
],
},
{