Skip to content

Commit 90c042b

Browse files
committed
more readme
1 parent 6871f26 commit 90c042b

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ Code reusability and easy of use for developers is also a prime consideration. A
2222

2323
1. Select a type of recording and open the recorder window
2424

25-
![](docs/images/recorder-menu.png)
25+
![](GenericFrameRecorder/docs/images/recorder-menu.png)
2626
2. Edit the recorders settings
2727

28-
![](docs/images/RecorderWindow.png)
28+
![](GenericFrameRecorder/docs/images/RecorderWindow.png)
2929

3030
3. Click "Start Recording" to lauch recording.
3131

@@ -36,25 +36,25 @@ Note that this can be done from edit mode and from game mode...
3636
2. Add a "Frame Recorder track" to the timeline.
3737
3. Add a "Frame Recorder clip" to the track.
3838
4. Select the newly added slip
39-
![](docs/images/TimelineTrack.png)
39+
![](GenericFrameRecorder/docs/images/TimelineTrack.png)
4040
5. Edit the clip's settings
41-
![](docs/images/RecorderClip.png)
41+
![](GenericFrameRecorder/docs/images/RecorderClip.png)
4242
6. Enter play mode and trigger the timeline through behaviours...
4343

4444
## Design
4545

4646
### Conceptual blocks breakdown
4747
The Recording framework is composed of three conceptual groups:
4848

49-
![](docs/images/ConceptualBlocks.PNG)
49+
![](GenericFrameRecorder/docs/images/ConceptualBlocks.PNG)
5050
* **Recorders**: the part that takes data feeds (Inputs) and transform them into whatever format they want (Image input -> mp4 file). They do NOT deal with gathering the data from Unity: that is the Inputs task. Every recorder is broken down into three pieces: Recorder, Settings and Settings Editor.
5151
* **Inputs**: specialized classes that know how to gather a given type of data from unity and how to pre-package that data in a way that is ready from consumption by the Recorders. Like recorders, Inputs are borken down into three parts: Input, Setttings and Settings Editor.
5252
* **Support**: holds the FrameRecorder's logic, UI, timeline integration and services.
5353

5454
### Recorders and there Inputs
5555
Here are the classes that make up recorders and their inputs.
5656

57-
![](docs/images/Recorders and inputs.PNG)
57+
![](GenericFrameRecorder/docs/images/Recorders_and_inputs.PNG)
5858

5959
#### Recorder:
6060
* Base/abstract class of all “recorders”. A recorder being the class that consumes the artifacts coming from the Unity engine and is responsible for transforming/encoding and “storing” them into the final output of a recording event. Examples would be: MP4, WAV, Alembic, Animation clips.
@@ -87,7 +87,7 @@ Here are the classes that make up recorders and their inputs.
8787
#### InputSettingsEditor
8888

8989
### The Recorder Editor classes
90-
![](docs/images/EditorClasses.PNG)
90+
![](GenericFrameRecorder/docs/images/EditorClasses.PNG)
9191

9292
### Game mode classes
9393

0 commit comments

Comments
 (0)