Skip to content

Commit 8304957

Browse files
committed
Fix <ul> in tables
1 parent 1193670 commit 8304957

File tree

3 files changed

+108
-30
lines changed

3 files changed

+108
-30
lines changed

docs/reference/EncoderHostScript.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -422,9 +422,17 @@ Notify when the batch encoder status has changed. Get the new status from the `b
422422

423423
#### Properties
424424

425-
| Property | Type | Description |
426-
| -------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
427-
| `batchEncoderStatus` | String | Returns the status of the batch encoder, when the event was sent. The values are:<ul><li>`"invalid"`</li><li>`"paused"`</li><li>`"running"`</li><li>`"stopped"`</li><li>`"stopping"`</li></ul> |
425+
+----------------------+--------+-----------------------------------------------------------------------------------+
426+
| Property | Type | Description |
427+
+======================+========+===================================================================================+
428+
| `batchEncoderStatus` | String | Returns the status of the batch encoder, when the event was sent. The values are: |
429+
| | | |
430+
| | | - `"invalid"` |
431+
| | | - `"paused"` |
432+
| | | - `"running"` |
433+
| | | - `"stopped"` |
434+
| | | - `"stopping"` |
435+
+----------------------+--------+-----------------------------------------------------------------------------------+
428436

429437
---
430438

docs/reference/EncoderWrapper.md

+76-22
Original file line numberDiff line numberDiff line change
@@ -504,9 +504,19 @@ Sets the crop type
504504

505505
#### Parameters
506506

507-
| Parameter | Type | Description |
508-
| ---------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
509-
| `cropType` | Unsigned int | <ul><li>0 – `ScaleToFit`</li><li>1 – `ScaleToFitBeforeCrop`</li><li>2 – `SetAsOutputSize`</li><li>3 – `ScaleToFill`</li><li>4 – `ScaleToFillBeforeCrop`</li><li>5 – `StretchToFill`</li><li>6 – `StretchToFillBeforeCrop`</ul> |
507+
+------------+--------------+---------------------------------+
508+
| Parameter | Type | Description |
509+
+============+==============+=================================+
510+
| `cropType` | Unsigned int | One of: |
511+
| | | |
512+
| | | - 0 - `ScaleToFit` |
513+
| | | - 1 - `ScaleToFitBeforeCrop` |
514+
| | | - 2 - `SetAsOutputSize` |
515+
| | | - 3 - `ScaleToFill` |
516+
| | | - 4 - `ScaleToFillBeforeCrop` |
517+
| | | - 5 - `StretchToFill` |
518+
| | | - 6 - `StretchToFillBeforeCrop` |
519+
+------------+--------------+---------------------------------+
510520

511521
#### Returns
512522

@@ -625,9 +635,19 @@ Sets the scale type
625635

626636
#### Parameters
627637

628-
| Parameter | Type | Description |
629-
| ----------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
630-
| `scaleType` | Unsigned int | <ul><li>0 – `ScaleToFit`</li><li>1 – `ScaleToFitBeforeCrop`</li><li>2 – `SetAsOutputSize`</li><li>3 – `ScaleToFill`</li><li>4 – `ScaleToFillBeforeCrop`</li><li>5 – `StretchToFill`</li><li>6 – `StretchToFillBeforeCrop`</ul> |
638+
+-------------+--------------+---------------------------------+
639+
| Parameter | Type | Description |
640+
+=============+==============+=================================+
641+
| `scaleType` | Unsigned int | One of: |
642+
| | | |
643+
| | | - 0 - `ScaleToFit` |
644+
| | | - 1 - `ScaleToFitBeforeCrop` |
645+
| | | - 2 - `SetAsOutputSize` |
646+
| | | - 3 - `ScaleToFill` |
647+
| | | - 4 - `ScaleToFillBeforeCrop` |
648+
| | | - 5 - `StretchToFill` |
649+
| | | - 6 - `StretchToFillBeforeCrop` |
650+
+-------------+--------------+---------------------------------+
631651

632652
#### Returns
633653

@@ -645,9 +665,16 @@ Set the time interpolation type
645665

646666
#### Parameters
647667

648-
| Parameter | Type | Description |
649-
| ------------------- | ------------ | ------------------------------------------------------------------------------------- |
650-
| `interpolationType` | Unsigned int | <ul><li>0 – FrameSampling</li><li>1 – FrameBlending</li><li>2 – OpticalFlow</li></ul> |
668+
+---------------------+--------------+-----------------------+
669+
| Parameter | Type | Description |
670+
+=====================+==============+=======================+
671+
| `interpolationType` | Unsigned int | One of: |
672+
| | | |
673+
| | | - 0 - `FrameSampling` |
674+
| | | - 1 - `FrameBlending` |
675+
| | | - 2 - `OpticalFlow` |
676+
+---------------------+--------------+-----------------------+
677+
651678

652679
#### Returns
653680

@@ -725,11 +752,21 @@ Sets the work area type, start and end time for the batch item.
725752

726753
#### Parameters
727754

728-
| Parameter | Type | Description |
729-
| -------------- | ------------ | --------------------------------------------------------------------------------------------------------------- |
730-
| `workAreaType` | Unsigned int | <ul><li>0 – Entire</li><li>1 – InToOut</li><li>2 – WorkArea</li><li>3 – Custom</li><li>4 – UseDefault</li></ul> |
731-
| `startTime` | Float | Start time |
732-
| `endTime` | Float | End time |
755+
+----------------+--------------+--------------------+
756+
| Parameter | Type | Description |
757+
+================+==============+====================+
758+
| `workAreaType` | Unsigned int | One of: |
759+
| | | |
760+
| | | - 0 - `Entire` |
761+
| | | - 1 - `InToOut` |
762+
| | | - 2 - `WorkArea` |
763+
| | | - 3 - `Custom` |
764+
| | | - 4 - `UseDefault` |
765+
+----------------+--------------+--------------------+
766+
| `startTime` | Float | Start time |
767+
+----------------+--------------+--------------------+
768+
| `endTime` | Float | End time |
769+
+----------------+--------------+--------------------+
733770

734771
#### Returns
735772

@@ -750,11 +787,22 @@ Sets the work area type, start and end time in ticks for the batch item
750787

751788
#### Parameters
752789

753-
| Parameter | Type | Description |
754-
| -------------- | ------------ | --------------------------------------------------------------------------------------------------------------- |
755-
| `workAreaType` | Unsigned int | <ul><li>0 – Entire</li><li>1 – InToOut</li><li>2 – WorkArea</li><li>3 – Custom</li><li>4 – UseDefault</li></ul> |
756-
| `startTime` | Float | Start time, in ticks |
757-
| `endTime` | Float | End time, in ticks |
790+
+----------------+--------------+----------------------+
791+
| Parameter | Type | Description |
792+
+================+==============+======================+
793+
| `workAreaType` | Unsigned int | One of: |
794+
| | | |
795+
| | | - 0 - `Entire` |
796+
| | | - 1 - `InToOut` |
797+
| | | - 2 - `WorkArea` |
798+
| | | - 3 - `Custom` |
799+
| | | - 4 - `UseDefault` |
800+
| | | |
801+
+----------------+--------------+----------------------+
802+
| `startTime` | Float | Start time, in ticks |
803+
+----------------+--------------+----------------------+
804+
| `endTime` | Float | End time, in ticks |
805+
+----------------+--------------+----------------------+
758806

759807
#### Returns
760808

@@ -915,9 +963,15 @@ Notify when the batch item has been encoded.
915963

916964
#### Properties
917965

918-
| Property | Type | Description |
919-
| -------- | ------ | -------------------------------------------------------------------------------------------------------- |
920-
| `result` | String | Returns the encoding result, one of:<ul><li>`"Done!"`</li><li>`"Failed!"`</li><li>`"Stopped!"`</li></ul> |
966+
+----------+--------+--------------------------------------+
967+
| Property | Type | Description |
968+
+==========+========+======================================+
969+
| `result` | String | Returns the encoding result, one of: |
970+
| | | |
971+
| | | - `"Done!"` |
972+
| | | - `"Failed!"` |
973+
| | | - `"Stopped!"` |
974+
+----------+--------+--------------------------------------+
921975

922976
---
923977

docs/reference/ExporterScript.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -615,11 +615,27 @@ Notify when batch item status has been changed.
615615

616616
#### Properties
617617

618-
| Property | Type | Description |
619-
| ------------ | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
620-
| `groupIndex` | Unsigned int | Returns the batch group index. |
621-
| `itemIndex` | Unsigned int | Returns the batch item index. |
622-
| `status` | Unsigned int | Returns the batch item status, one of: <ul><li>0 – Waiting</li><li>1 – Done</li><li>2 – Failed</li><li>3 – Skipped</li><li>4 – Encoding</li><li>5 – Paused</li><li>6 – Stopped</li><li>7 – Any</li><li>8 – AutoStart</li><li>9 – Done Warning</li><li>10 – Watch Folder Waiting</li></ul> |
618+
+--------------+--------------+----------------------------------------+
619+
| Property | Type | Description |
620+
+==============+==============+========================================+
621+
| `groupIndex` | Unsigned int | Returns the batch group index. |
622+
+--------------+--------------+----------------------------------------+
623+
| `itemIndex` | Unsigned int | Returns the batch item index. |
624+
+--------------+--------------+----------------------------------------+
625+
| `status` | Unsigned int | Returns the batch item status, one of: |
626+
| | | |
627+
| | | - 0 - Waiting |
628+
| | | - 1 - Done |
629+
| | | - 2 - Failed |
630+
| | | - 3 - Skipped |
631+
| | | - 4 - Encoding |
632+
| | | - 5 - Paused |
633+
| | | - 6 - Stopped |
634+
| | | - 7 - Any |
635+
| | | - 8 - AutoStart |
636+
| | | - 9 - Done Warning |
637+
| | | - 10 - Watch Folder Waiting |
638+
+--------------+--------------+----------------------------------------+
623639

624640
#### Examples
625641

0 commit comments

Comments
 (0)