Skip to content

Commit 4183d22

Browse files
authored
reverted changes to otio-serialized-schema.md to match machine-generated version (#1824)
Signed-off-by: Eric Reinecke <[email protected]>
1 parent 5c50858 commit 4183d22

File tree

1 file changed

+89
-89
lines changed

1 file changed

+89
-89
lines changed

docs/tutorials/otio-serialized-schema.md

Lines changed: 89 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ An object that can be composed within a :class:`~Composition` (such as :class:`~
7070
```
7171

7272
parameters:
73-
- *metadata*:
74-
- *name*:
73+
- *metadata*:
74+
- *name*:
7575

7676
### Composition.1
7777

@@ -88,12 +88,12 @@ Should be subclassed (for example by :class:`.Track` and :class:`.Stack`), not u
8888
```
8989

9090
parameters:
91-
- *effects*:
91+
- *effects*:
9292
- *enabled*: If true, an Item contributes to compositions. For example, when an audio/video clip is ``enabled=false`` the clip is muted/hidden.
93-
- *markers*:
94-
- *metadata*:
95-
- *name*:
96-
- *source_range*:
93+
- *markers*:
94+
- *metadata*:
95+
- *name*:
96+
- *source_range*:
9797

9898
### Item.1
9999

@@ -106,12 +106,12 @@ None
106106
```
107107

108108
parameters:
109-
- *effects*:
109+
- *effects*:
110110
- *enabled*: If true, an Item contributes to compositions. For example, when an audio/video clip is ``enabled=false`` the clip is muted/hidden.
111-
- *markers*:
112-
- *metadata*:
113-
- *name*:
114-
- *source_range*:
111+
- *markers*:
112+
- *metadata*:
113+
- *name*:
114+
- *source_range*:
115115

116116
### MediaReference.1
117117

@@ -124,10 +124,10 @@ None
124124
```
125125

126126
parameters:
127-
- *available_image_bounds*:
128-
- *available_range*:
129-
- *metadata*:
130-
- *name*:
127+
- *available_image_bounds*:
128+
- *available_range*:
129+
- *metadata*:
130+
- *name*:
131131

132132
### SerializableObjectWithMetadata.1
133133

@@ -140,8 +140,8 @@ None
140140
```
141141

142142
parameters:
143-
- *metadata*:
144-
- *name*:
143+
- *metadata*:
144+
- *name*:
145145

146146
## Module: opentimelineio.hooks
147147

@@ -191,8 +191,8 @@ It can be rescaled into another :class:`~RationalTime`'s rate.
191191
```
192192

193193
parameters:
194-
- *rate*:
195-
- *value*:
194+
- *rate*:
195+
- *value*:
196196

197197
### TimeRange.1
198198

@@ -209,8 +209,8 @@ meaning that :meth:`end_time_inclusive` (last portion of a sample in the time ra
209209
```
210210

211211
parameters:
212-
- *duration*:
213-
- *start_time*:
212+
- *duration*:
213+
- *start_time*:
214214

215215
### TimeTransform.1
216216

@@ -223,9 +223,9 @@ parameters:
223223
```
224224

225225
parameters:
226-
- *offset*:
227-
- *rate*:
228-
- *scale*:
226+
- *offset*:
227+
- *rate*:
228+
- *scale*:
229229

230230
## Module: opentimelineio.plugins
231231

@@ -289,14 +289,14 @@ Contains a :class:`.MediaReference` and a trim on that media reference.
289289
```
290290

291291
parameters:
292-
- *active_media_reference_key*:
293-
- *effects*:
292+
- *active_media_reference_key*:
293+
- *effects*:
294294
- *enabled*: If true, an Item contributes to compositions. For example, when an audio/video clip is ``enabled=false`` the clip is muted/hidden.
295-
- *markers*:
296-
- *media_references*:
297-
- *metadata*:
298-
- *name*:
299-
- *source_range*:
295+
- *markers*:
296+
- *media_references*:
297+
- *metadata*:
298+
- *name*:
299+
- *source_range*:
300300

301301
### Effect.1
302302

@@ -309,10 +309,10 @@ None
309309
```
310310

311311
parameters:
312-
- *effect_name*:
312+
- *effect_name*:
313313
- *enabled*: If true, the Effect is applied. If false, the Effect is omitted.
314-
- *metadata*:
315-
- *name*:
314+
- *metadata*:
315+
- *name*:
316316

317317
### ExternalReference.1
318318

@@ -325,11 +325,11 @@ None
325325
```
326326

327327
parameters:
328-
- *available_image_bounds*:
329-
- *available_range*:
330-
- *metadata*:
331-
- *name*:
332-
- *target_url*:
328+
- *available_image_bounds*:
329+
- *available_range*:
330+
- *metadata*:
331+
- *name*:
332+
- *target_url*:
333333

334334
### FreezeFrame.1
335335

@@ -342,10 +342,10 @@ Hold the first frame of the clip for the duration of the clip.
342342
```
343343

344344
parameters:
345-
- *effect_name*:
345+
- *effect_name*:
346346
- *enabled*: If true, the Effect is applied. If false, the Effect is omitted.
347-
- *metadata*:
348-
- *name*:
347+
- *metadata*:
348+
- *name*:
349349
- *time_scalar*: Linear time scalar applied to clip. 2.0 means the clip occupies half the time in the parent item, i.e. plays at double speed,
350350
0.5 means the clip occupies twice the time in the parent item, i.e. plays at half speed.
351351

@@ -363,12 +363,12 @@ None
363363
```
364364

365365
parameters:
366-
- *effects*:
366+
- *effects*:
367367
- *enabled*: If true, an Item contributes to compositions. For example, when an audio/video clip is ``enabled=false`` the clip is muted/hidden.
368-
- *markers*:
369-
- *metadata*:
370-
- *name*:
371-
- *source_range*:
368+
- *markers*:
369+
- *metadata*:
370+
- *name*:
371+
- *source_range*:
372372

373373
### GeneratorReference.1
374374

@@ -381,12 +381,12 @@ None
381381
```
382382

383383
parameters:
384-
- *available_image_bounds*:
385-
- *available_range*:
386-
- *generator_kind*:
387-
- *metadata*:
388-
- *name*:
389-
- *parameters*:
384+
- *available_image_bounds*:
385+
- *available_range*:
386+
- *generator_kind*:
387+
- *metadata*:
388+
- *name*:
389+
- *parameters*:
390390

391391
### ImageSequenceReference.1
392392

@@ -475,13 +475,13 @@ yield the first three target urls as:
475475
```
476476

477477
parameters:
478-
- *available_image_bounds*:
479-
- *available_range*:
478+
- *available_image_bounds*:
479+
- *available_range*:
480480
- *frame_step*: Step between frame numbers in file names.
481481
- *frame_zero_padding*: Number of digits to pad zeros out to in frame numbers.
482-
- *metadata*:
482+
- *metadata*:
483483
- *missing_frame_policy*: Directive for how frames in sequence not found during playback or rendering should be handled.
484-
- *name*:
484+
- *name*:
485485
- *name_prefix*: Everything in the file name leading up to the frame number.
486486
- *name_suffix*: Everything after the frame number in the file name.
487487
- *rate*: Frame rate if every frame in the sequence were played back.
@@ -501,10 +501,10 @@ A time warp that applies a linear speed up or slow down across the entire clip.
501501
```
502502

503503
parameters:
504-
- *effect_name*:
504+
- *effect_name*:
505505
- *enabled*: If true, the Effect is applied. If false, the Effect is omitted.
506-
- *metadata*:
507-
- *name*:
506+
- *metadata*:
507+
- *name*:
508508
- *time_scalar*: Linear time scalar applied to clip. 2.0 means the clip occupies half the time in the parent item, i.e. plays at double speed,
509509
0.5 means the clip occupies twice the time in the parent item, i.e. plays at half speed.
510510

@@ -531,8 +531,8 @@ parameters:
531531
- *color*: Color string for this marker (for example: 'RED'), based on the :class:`~Color` enum.
532532
- *comment*: Optional comment for this marker.
533533
- *marked_range*: Range this marker applies to, relative to the :class:`.Item` this marker is attached to (e.g. the :class:`.Clip` or :class:`.Track` that owns this marker).
534-
- *metadata*:
535-
- *name*:
534+
- *metadata*:
535+
- *name*:
536536

537537
### MissingReference.1
538538

@@ -550,10 +550,10 @@ is not known.
550550
```
551551

552552
parameters:
553-
- *available_image_bounds*:
554-
- *available_range*:
555-
- *metadata*:
556-
- *name*:
553+
- *available_image_bounds*:
554+
- *available_range*:
555+
- *metadata*:
556+
- *name*:
557557

558558
### SerializableCollection.1
559559

@@ -577,8 +577,8 @@ references to a single file.
577577
```
578578

579579
parameters:
580-
- *metadata*:
581-
- *name*:
580+
- *metadata*:
581+
- *name*:
582582

583583
### Stack.1
584584

@@ -591,12 +591,12 @@ None
591591
```
592592

593593
parameters:
594-
- *effects*:
594+
- *effects*:
595595
- *enabled*: If true, an Item contributes to compositions. For example, when an audio/video clip is ``enabled=false`` the clip is muted/hidden.
596-
- *markers*:
597-
- *metadata*:
598-
- *name*:
599-
- *source_range*:
596+
- *markers*:
597+
- *metadata*:
598+
- *name*:
599+
- *source_range*:
600600

601601
### TimeEffect.1
602602

@@ -609,10 +609,10 @@ Base class for all effects that alter the timing of an item.
609609
```
610610

611611
parameters:
612-
- *effect_name*:
612+
- *effect_name*:
613613
- *enabled*: If true, the Effect is applied. If false, the Effect is omitted.
614-
- *metadata*:
615-
- *name*:
614+
- *metadata*:
615+
- *name*:
616616

617617
### Timeline.1
618618

@@ -625,10 +625,10 @@ None
625625
```
626626

627627
parameters:
628-
- *global_start_time*:
629-
- *metadata*:
630-
- *name*:
631-
- *tracks*:
628+
- *global_start_time*:
629+
- *metadata*:
630+
- *name*:
631+
- *tracks*:
632632

633633
### Track.1
634634

@@ -641,13 +641,13 @@ None
641641
```
642642

643643
parameters:
644-
- *effects*:
644+
- *effects*:
645645
- *enabled*: If true, an Item contributes to compositions. For example, when an audio/video clip is ``enabled=false`` the clip is muted/hidden.
646-
- *kind*:
647-
- *markers*:
648-
- *metadata*:
649-
- *name*:
650-
- *source_range*:
646+
- *kind*:
647+
- *markers*:
648+
- *metadata*:
649+
- *name*:
650+
- *source_range*:
651651

652652
### Transition.1
653653

@@ -662,8 +662,8 @@ dissolve or wipe.
662662

663663
parameters:
664664
- *in_offset*: Amount of the previous clip this transition overlaps, exclusive.
665-
- *metadata*:
666-
- *name*:
665+
- *metadata*:
666+
- *name*:
667667
- *out_offset*: Amount of the next clip this transition overlaps, exclusive.
668668
- *transition_type*: Kind of transition, as defined by the :class:`Type` enum.
669669

0 commit comments

Comments
 (0)