Skip to content

Commit 72f9674

Browse files
Tim020claude
andcommitted
docs: Add documentation and screenshots for microphone features
- Document conflict detection with orange/blue highlighting - Add comprehensive Timeline view documentation (3 view modes) - Document Scene Density Heatmap features and interpretation - Add Resource Availability Dashboard documentation - Include 4 new screenshots showing all features Fix: Correct conflict detection in ResourceAvailability component - Use correct property names (micId, sceneId, adjacentSceneId) - Filter conflicts by scene ID instead of nested scenes array 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
1 parent 7d225d1 commit 72f9674

File tree

6 files changed

+93
-2
lines changed

6 files changed

+93
-2
lines changed

client/src/vue_components/show/config/mics/ResourceAvailability.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ export default {
218218
219219
// Get conflicts for this scene
220220
const allConflicts = this.MIC_CONFLICTS?.conflicts || [];
221-
const sceneConflicts = allConflicts.filter((conflict) => conflict.scenes.some((s) => s.id === scene.id));
221+
const sceneConflicts = allConflicts.filter((conflict) => conflict.sceneId === scene.id || conflict.adjacentSceneId === scene.id);
222222
223223
this.microphones.forEach((mic) => {
224224
const micAllocs = this.allocations[mic.id];
@@ -238,7 +238,7 @@ export default {
238238
inUse += 1;
239239
240240
// Check if this mic has a conflict in this scene
241-
const hasConflict = sceneConflicts.some((conflict) => conflict.microphone.id === mic.id);
241+
const hasConflict = sceneConflicts.some((conflict) => conflict.micId === mic.id);
242242
if (hasConflict) {
243243
status = 'conflict';
244244
statusClass = 'conflict';
189 KB
Loading
114 KB
Loading
130 KB
Loading
119 KB
Loading

docs/pages/show_config/microphones.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,94 @@ After making your allocations, click the **Save** button to confirm your changes
4747
![](../../images/config_show/mics_allocations_saved.png)
4848

4949
The saved view provides a clear overview of microphone usage throughout the entire show, helping sound engineers plan microphone management and character coverage.
50+
51+
#### Conflict Detection
52+
53+
DigiScript automatically detects potential microphone conflicts when the same microphone is allocated to different characters in adjacent scenes. Conflicts are highlighted in the allocations matrix to alert you to quick-changes that may require attention:
54+
55+
![](../../images/config_show/mics_conflict_highlighting.png)
56+
57+
- **Orange highlights** indicate conflicts within the same act (tight changeover required)
58+
- **Blue highlights** indicate conflicts across act boundaries (interval provides changeover time)
59+
60+
Hovering over a highlighted allocation shows details about the conflict, including which scenes and characters are involved.
61+
62+
### Microphone Timeline View
63+
64+
The **Timeline** tab provides a visual representation of microphone allocations across all scenes in the show. This view helps you understand allocation patterns and identify conflicts at a glance.
65+
66+
![](../../images/config_show/mics_timeline.png)
67+
68+
#### Timeline Features
69+
70+
- **View Modes**: Switch between three different perspectives:
71+
- **By Microphone**: Shows which characters use each microphone across scenes
72+
- **By Character**: Shows which microphones each character uses across scenes
73+
- **By Cast**: Shows microphone usage grouped by cast member
74+
75+
- **Visual Layout**: The timeline uses color-coded bars to represent allocations:
76+
- Each row represents a microphone, character, or cast member (depending on view mode)
77+
- Each column represents a scene in the show
78+
- Acts are labeled at the top for easy reference
79+
- Colored bars show continuous allocations (same entity across multiple scenes)
80+
81+
- **Export**: Click the download button to export the timeline as a PNG image for documentation or planning purposes
82+
83+
#### Using the Timeline
84+
85+
1. Select your preferred view mode using the buttons at the top
86+
2. Scroll horizontally to see all scenes in large shows
87+
3. Click on allocation bars to see detailed information
88+
4. Colors are automatically assigned to distinguish different entities
89+
90+
### Scene Density Heatmap
91+
92+
The **Density** tab visualizes technical complexity by showing how many microphones are active in each scene. This helps identify technically demanding scenes that may require additional crew or planning.
93+
94+
![](../../images/config_show/mics_density_heatmap.png)
95+
96+
#### Heatmap Features
97+
98+
- **Color Gradient**: Scenes are color-coded from blue (low mic count) to red (high mic count)
99+
- **Act Grouping**: Scenes are organized by act for easy reference
100+
- **Scene Statistics**: Displays total scenes, average mics per scene, peak usage, and total active mics
101+
- **Interactive Bars**: Click on scene bars to see detailed information
102+
103+
#### Interpreting the Heatmap
104+
105+
- Darker red scenes require more microphones and may be more technically complex
106+
- Blue scenes with fewer microphones may be simpler to manage
107+
- Use peak usage information to ensure you have enough microphone inventory
108+
- Identify scenes that may require additional sound crew attention
109+
110+
### Resource Availability Dashboard
111+
112+
The **Availability** tab provides a comprehensive overview of microphone resource planning across the entire show. This view helps with inventory management and resource allocation.
113+
114+
![](../../images/config_show/mics_availability.png)
115+
116+
#### Dashboard Features
117+
118+
- **Summary Statistics**:
119+
- Total microphones in inventory
120+
- Peak simultaneous usage (maximum mics needed at once)
121+
- Total conflicts detected across the show
122+
- Average utilization rate (percentage of mic inventory in use)
123+
124+
- **Scene-by-Scene Breakdown**: For each scene, see:
125+
- Number of available microphones (not in use)
126+
- Number of microphones in use
127+
- Number of conflicts requiring attention
128+
129+
- **Microphone Status Grid**: Color-coded cards show the status of each microphone in each scene:
130+
- **Green**: Microphone is available (not allocated)
131+
- **Blue**: Microphone is in use by a character
132+
- **Red (pulsing)**: Microphone has a conflict with adjacent scenes
133+
134+
#### Using the Availability Dashboard
135+
136+
1. Review summary statistics to ensure sufficient microphone inventory
137+
2. Check the utilization rate to identify over or under-provisioning
138+
3. Scan the scene-by-scene breakdown for scenes with conflicts
139+
4. Click on microphone cards to see detailed allocation information
140+
5. Use conflict indicators to identify scenes requiring changeover planning

0 commit comments

Comments
 (0)