Skip to content

Commit f26d633

Browse files
root(readme): add watermark param to renderProject method.
- update the render method documentation.
1 parent 0c1566a commit f26d633

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,9 @@ var_dump($duplicateProject); // handle the success
357357

358358
### Render the Project
359359

360-
Renders the project.
360+
Renders the project with given quality. The possible values for the quality are: 0, 360, 720, and 1080.
361+
The watermark parameter is optional, must be in '.png' file format and have canvas size of 1920 x 1080 pixels,
362+
url length must not exceed 250 characters and is not applicable to HD quality videos.
361363

362364
```php
363365
<?php
@@ -368,7 +370,8 @@ $renderforest = new \Renderforest\Client(['signKey' => '<signKey>', 'clientId' =
368370

369371
$payload = [
370372
'projectId' => 5000658,
371-
'quality' => 1080
373+
'quality' => 360,
374+
'watermark' => 'https://example.com/watermark.png' // optional parameter
372375
];
373376
try {
374377
$renderProject = $renderforest->renderProject($payload);

0 commit comments

Comments
 (0)