Skip to content

update ImageAsset docs #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeffski merged 2 commits into from
Nov 18, 2021
Merged

update ImageAsset docs #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0063371
update ImageAsset docs
vladbdev Nov 17, 2021
7711042
remove type reference for ImageAsset
vladbdev Nov 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 19 additions & 8 deletions docs/model/ImageAsset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
# # ImageAsset
# ImageAsset()

## Properties
The **ImageAsset** is used to create video from images to compose an image. The src must be a publicly accessible URL to an image resource such as a jpg or png file.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **string** | The type of asset - set to `image` for images. | [default to 'image']
**src** | **string** | The image source URL. The URL must be publicly accessible or include credentials. |
**crop** | [**\Shotstack\Client\Model\Crop**](Crop.md) | | [optional]
### Example:

```
use Shotstack\Client\Model\ImageAsset;

$imageAsset = new ImageAsset();
$imageAsset
->setSrc('https://shotstack-assets.s3-ap-southeast-2.amazonaws.com/images/earth.jpg')
->setCrop($crop);
```

### Methods:

Method | Description | Required
:--- | :--- | :---:
setSrc(string $url) | The image source URL. The URL must be publicly accessible or include credentials. | Y
setCrop([\Shotstack\Client\Model\Crop](Crop.md) $crop) | Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e. a left crop of 0.5 will crop half of the asset from the left, a top crop of 0.25 will crop the top by quarter of the asset. | -

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)