You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorials/otio-serialized-schema.md
+89-89Lines changed: 89 additions & 89 deletions
Original file line number
Diff line number
Diff line change
@@ -70,8 +70,8 @@ An object that can be composed within a :class:`~Composition` (such as :class:`~
70
70
```
71
71
72
72
parameters:
73
-
-*metadata*:
74
-
-*name*:
73
+
-*metadata*:
74
+
-*name*:
75
75
76
76
### Composition.1
77
77
@@ -88,12 +88,12 @@ Should be subclassed (for example by :class:`.Track` and :class:`.Stack`), not u
88
88
```
89
89
90
90
parameters:
91
-
-*effects*:
91
+
-*effects*:
92
92
-*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*:
97
97
98
98
### Item.1
99
99
@@ -106,12 +106,12 @@ None
106
106
```
107
107
108
108
parameters:
109
-
-*effects*:
109
+
-*effects*:
110
110
-*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*:
115
115
116
116
### MediaReference.1
117
117
@@ -124,10 +124,10 @@ None
124
124
```
125
125
126
126
parameters:
127
-
-*available_image_bounds*:
128
-
-*available_range*:
129
-
-*metadata*:
130
-
-*name*:
127
+
-*available_image_bounds*:
128
+
-*available_range*:
129
+
-*metadata*:
130
+
-*name*:
131
131
132
132
### SerializableObjectWithMetadata.1
133
133
@@ -140,8 +140,8 @@ None
140
140
```
141
141
142
142
parameters:
143
-
-*metadata*:
144
-
-*name*:
143
+
-*metadata*:
144
+
-*name*:
145
145
146
146
## Module: opentimelineio.hooks
147
147
@@ -191,8 +191,8 @@ It can be rescaled into another :class:`~RationalTime`'s rate.
191
191
```
192
192
193
193
parameters:
194
-
-*rate*:
195
-
-*value*:
194
+
-*rate*:
195
+
-*value*:
196
196
197
197
### TimeRange.1
198
198
@@ -209,8 +209,8 @@ meaning that :meth:`end_time_inclusive` (last portion of a sample in the time ra
209
209
```
210
210
211
211
parameters:
212
-
-*duration*:
213
-
-*start_time*:
212
+
-*duration*:
213
+
-*start_time*:
214
214
215
215
### TimeTransform.1
216
216
@@ -223,9 +223,9 @@ parameters:
223
223
```
224
224
225
225
parameters:
226
-
-*offset*:
227
-
-*rate*:
228
-
-*scale*:
226
+
-*offset*:
227
+
-*rate*:
228
+
-*scale*:
229
229
230
230
## Module: opentimelineio.plugins
231
231
@@ -289,14 +289,14 @@ Contains a :class:`.MediaReference` and a trim on that media reference.
289
289
```
290
290
291
291
parameters:
292
-
-*active_media_reference_key*:
293
-
-*effects*:
292
+
-*active_media_reference_key*:
293
+
-*effects*:
294
294
-*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*:
300
300
301
301
### Effect.1
302
302
@@ -309,10 +309,10 @@ None
309
309
```
310
310
311
311
parameters:
312
-
-*effect_name*:
312
+
-*effect_name*:
313
313
-*enabled*: If true, the Effect is applied. If false, the Effect is omitted.
314
-
-*metadata*:
315
-
-*name*:
314
+
-*metadata*:
315
+
-*name*:
316
316
317
317
### ExternalReference.1
318
318
@@ -325,11 +325,11 @@ None
325
325
```
326
326
327
327
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*:
333
333
334
334
### FreezeFrame.1
335
335
@@ -342,10 +342,10 @@ Hold the first frame of the clip for the duration of the clip.
342
342
```
343
343
344
344
parameters:
345
-
-*effect_name*:
345
+
-*effect_name*:
346
346
-*enabled*: If true, the Effect is applied. If false, the Effect is omitted.
347
-
-*metadata*:
348
-
-*name*:
347
+
-*metadata*:
348
+
-*name*:
349
349
-*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,
350
350
0.5 means the clip occupies twice the time in the parent item, i.e. plays at half speed.
351
351
@@ -363,12 +363,12 @@ None
363
363
```
364
364
365
365
parameters:
366
-
-*effects*:
366
+
-*effects*:
367
367
-*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*:
372
372
373
373
### GeneratorReference.1
374
374
@@ -381,12 +381,12 @@ None
381
381
```
382
382
383
383
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*:
390
390
391
391
### ImageSequenceReference.1
392
392
@@ -475,13 +475,13 @@ yield the first three target urls as:
475
475
```
476
476
477
477
parameters:
478
-
-*available_image_bounds*:
479
-
-*available_range*:
478
+
-*available_image_bounds*:
479
+
-*available_range*:
480
480
-*frame_step*: Step between frame numbers in file names.
481
481
-*frame_zero_padding*: Number of digits to pad zeros out to in frame numbers.
482
-
-*metadata*:
482
+
-*metadata*:
483
483
-*missing_frame_policy*: Directive for how frames in sequence not found during playback or rendering should be handled.
484
-
-*name*:
484
+
-*name*:
485
485
-*name_prefix*: Everything in the file name leading up to the frame number.
486
486
-*name_suffix*: Everything after the frame number in the file name.
487
487
-*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.
501
501
```
502
502
503
503
parameters:
504
-
-*effect_name*:
504
+
-*effect_name*:
505
505
-*enabled*: If true, the Effect is applied. If false, the Effect is omitted.
506
-
-*metadata*:
507
-
-*name*:
506
+
-*metadata*:
507
+
-*name*:
508
508
-*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,
509
509
0.5 means the clip occupies twice the time in the parent item, i.e. plays at half speed.
510
510
@@ -531,8 +531,8 @@ parameters:
531
531
-*color*: Color string for this marker (for example: 'RED'), based on the :class:`~Color` enum.
532
532
-*comment*: Optional comment for this marker.
533
533
-*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*:
536
536
537
537
### MissingReference.1
538
538
@@ -550,10 +550,10 @@ is not known.
550
550
```
551
551
552
552
parameters:
553
-
-*available_image_bounds*:
554
-
-*available_range*:
555
-
-*metadata*:
556
-
-*name*:
553
+
-*available_image_bounds*:
554
+
-*available_range*:
555
+
-*metadata*:
556
+
-*name*:
557
557
558
558
### SerializableCollection.1
559
559
@@ -577,8 +577,8 @@ references to a single file.
577
577
```
578
578
579
579
parameters:
580
-
-*metadata*:
581
-
-*name*:
580
+
-*metadata*:
581
+
-*name*:
582
582
583
583
### Stack.1
584
584
@@ -591,12 +591,12 @@ None
591
591
```
592
592
593
593
parameters:
594
-
-*effects*:
594
+
-*effects*:
595
595
-*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*:
600
600
601
601
### TimeEffect.1
602
602
@@ -609,10 +609,10 @@ Base class for all effects that alter the timing of an item.
609
609
```
610
610
611
611
parameters:
612
-
-*effect_name*:
612
+
-*effect_name*:
613
613
-*enabled*: If true, the Effect is applied. If false, the Effect is omitted.
614
-
-*metadata*:
615
-
-*name*:
614
+
-*metadata*:
615
+
-*name*:
616
616
617
617
### Timeline.1
618
618
@@ -625,10 +625,10 @@ None
625
625
```
626
626
627
627
parameters:
628
-
-*global_start_time*:
629
-
-*metadata*:
630
-
-*name*:
631
-
-*tracks*:
628
+
-*global_start_time*:
629
+
-*metadata*:
630
+
-*name*:
631
+
-*tracks*:
632
632
633
633
### Track.1
634
634
@@ -641,13 +641,13 @@ None
641
641
```
642
642
643
643
parameters:
644
-
-*effects*:
644
+
-*effects*:
645
645
-*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*:
651
651
652
652
### Transition.1
653
653
@@ -662,8 +662,8 @@ dissolve or wipe.
662
662
663
663
parameters:
664
664
-*in_offset*: Amount of the previous clip this transition overlaps, exclusive.
665
-
-*metadata*:
666
-
-*name*:
665
+
-*metadata*:
666
+
-*name*:
667
667
-*out_offset*: Amount of the next clip this transition overlaps, exclusive.
668
668
-*transition_type*: Kind of transition, as defined by the :class:`Type` enum.
0 commit comments