Skip to content

Commit 7253999

Browse files
authored
Merge pull request #22 from shotstack/docs
Update readme
2 parents 47c00c3 + 62992ea commit 7253999

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ setLength(float $length) | The length, in seconds, the Clip should play for. | Y
326326
setFit(string $fit) | Set how the asset should be scaled to fit the viewport using one of the following options [default to `crop`]: <ul><li>`cover` - stretch the asset to fill the viewport without maintaining the aspect ratio.</li><li>`contain` - fit the entire asset within the viewport while maintaining the original aspect ratio.</li><li>`crop` - scale the asset to fill the viewport while maintaining the aspect ratio. The asset will be cropped if it exceeds the bounds of the viewport.</li><li>`none` - preserves the original asset dimensions and does not apply any scaling.</li></ul>| -
327327
setScale(float $scale) | Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and scaling images such as logos and watermarks. | -
328328
setPosition(string $position) | Place the asset in one of nine predefined positions of the viewport. This is most effective for when the asset is scaled and you want to position the element to a specific position [default to `center`].<ul><li>`top` - top (center)</li><li>`topRight` - top right</li><li>`right` - right (center)</li><li>`bottomRight` - bottom right</li><li>`bottom` - bottom (center)</li><li>`bottomLeft` - bottom left</li><li>`left` - left (center)</li><li>`topLeft` - top left</li><li>`center` - center</li></ul> | -
329-
stOffset([\Shotstack\Client\Model\Offset](#offset) $offset) | Offset the location of the asset relative to its position on the viewport. The offset distance is relative to the width of the viewport - for example an x offset of 0.5 will move the asset half the viewport width to the right. | -
329+
setOffset([\Shotstack\Client\Model\Offset](#offset) $offset) | Offset the location of the asset relative to its position on the viewport. The offset distance is relative to the width of the viewport - for example an x offset of 0.5 will move the asset half the viewport width to the right. | -
330330
setTransition([\Shotstack\Client\Model\Transition](#transition) $transition) | In and out transitions for a clip - i.e. fade in and fade out | -
331331
setEffect(string $effect) | A motion effect to apply to the Clip. <ul><li>`zoomIn` - slow zoom in</li><li>`zoomOut` - slow zoom out</li><li>`slideLeft` - slow slide (pan) left</li><li>`slideRight` - slow slide (pan) right</li><li>`slideUp` - slow slide (pan) up</li><li>`slideDown` - slow slide (pan) down</li></ul>| -
332332
setFilter(string $filter) | A filter effect to apply to the Clip. <ul><li>`boost` - boost contrast and saturation</li><li>`contrast` - increase contrast</li><li>`darken` - darken the scene</li><li>`greyscale` - remove colour</li><li>`lighten` - lighten the scene</li><li>`muted` - reduce saturation and contrast</li><li>`invert` - invert colors</li></ul> | -
@@ -938,7 +938,7 @@ getUpdated(): string | The time the render status was last updated. | Y
938938
---
939939
## Inspecting Media
940940

941-
The SDK `probe` endpoint can be used to inspect media hosted online. Simply pass the URL an asset to inspect.
941+
The SDK `probe` endpoint can be used to inspect media hosted online. Simply pass the URL of an asset to inspect.
942942
### Probe Example
943943

944944
The example below inspects (probes) a video hosted on GitHub and returns metadata about the file.

0 commit comments

Comments
 (0)