Defining conversions | laravel-medialibrary | Spatie

 SPATIE

  Laravel Media Library
========================

spatie.be/open-source

  [Docs](https://spatie.be/docs)  [Laravel-medialibrary](https://spatie.be/docs/laravel-medialibrary/v3)  Api  Defining conversions

 Version   v11   v10   v9   v8   v7   v6   v5   v4   v3

 Other versions for crawler [v11](https://spatie.be/docs/laravel-medialibrary/v11) [v10](https://spatie.be/docs/laravel-medialibrary/v10) [v9](https://spatie.be/docs/laravel-medialibrary/v9) [v8](https://spatie.be/docs/laravel-medialibrary/v8) [v7](https://spatie.be/docs/laravel-medialibrary/v7) [v6](https://spatie.be/docs/laravel-medialibrary/v6) [v5](https://spatie.be/docs/laravel-medialibrary/v5) [v4](https://spatie.be/docs/laravel-medialibrary/v4) [v3](https://spatie.be/docs/laravel-medialibrary/v3)

- [ Introduction ](https://spatie.be/docs/laravel-medialibrary/v3/introduction)
- [ Postcardware ](https://spatie.be/docs/laravel-medialibrary/v3/postcardware)
- [ Requirements ](https://spatie.be/docs/laravel-medialibrary/v3/requirements)
- [ Installation & setup ](https://spatie.be/docs/laravel-medialibrary/v3/installation-setup)
- [ Questions and issues ](https://spatie.be/docs/laravel-medialibrary/v3/questions-issues)
- [ Changelog ](https://spatie.be/docs/laravel-medialibrary/v3/changelog)

Basic usage
-----------

- [ Preparing your model ](https://spatie.be/docs/laravel-medialibrary/v3/basic-usage/preparing-your-model)
- [ Associating files ](https://spatie.be/docs/laravel-medialibrary/v3/basic-usage/associating-files)
- [ Retrieving media ](https://spatie.be/docs/laravel-medialibrary/v3/basic-usage/retrieving-media)
- [ Working with collections ](https://spatie.be/docs/laravel-medialibrary/v3/basic-usage/working-with-collections)

Converting images
-----------------

- [ Defining conversions ](https://spatie.be/docs/laravel-medialibrary/v3/converting-images/defining-conversions)
- [ Retrieving converted images ](https://spatie.be/docs/laravel-medialibrary/v3/converting-images/retrieving-converted-images)
- [ Regenerating images ](https://spatie.be/docs/laravel-medialibrary/v3/converting-images/regenerating-images)

Advanced usage
--------------

- [ Working with multiple filesystems ](https://spatie.be/docs/laravel-medialibrary/v3/advanced-usage/working-with-multiple-filesystems)
- [ Storing media specific manipulations ](https://spatie.be/docs/laravel-medialibrary/v3/advanced-usage/storing-media-specific-manipulations)
- [ Using your own model ](https://spatie.be/docs/laravel-medialibrary/v3/advanced-usage/using-your-own-model)
- [ Using a custom directory structure ](https://spatie.be/docs/laravel-medialibrary/v3/advanced-usage/using-a-custom-directory-structure)
- [ Consuming events ](https://spatie.be/docs/laravel-medialibrary/v3/advanced-usage/consuming-events)
- [ Generating custom urls ](https://spatie.be/docs/laravel-medialibrary/v3/advanced-usage/generating-custom-urls)
- [ Adding custom properties ](https://spatie.be/docs/laravel-medialibrary/v3/advanced-usage/adding-custom-properties)

API
---

- [ Adding files ](https://spatie.be/docs/laravel-medialibrary/v3/api/adding-files)
- [ Defining conversions ](https://spatie.be/docs/laravel-medialibrary/v3/api/defining-conversions)

      You are viewing the documentation for **an older version** of this package. You can check the version you are using with the following command:

 `                                    composer show spatie/laravel-medialibrary                                                                                                                                                                                                                                    `

Defining conversions
====================

###  On this page

1. [ General methods ](#content-general-methods)
2. [ Glide convenience methods ](#content-glide-convenience-methods)

A media conversion can be added to your model in the `registerModelConversions`-function. It should start with a call to `addMediaConversion`. From there on you can use any of the methods available in the API. They are all chainable.

Take a look in the [Defining conversions section](/laravel-medialibrary/v3/converting-images/defining-conversions/)for more details.

General methods
-----------------------------------------------------------------------------------------------------

### addMediaConversion

```
/**
 * Add a conversion.
 *
 * @param string $nam
 *
 * @return \Spatie\MediaLibrary\Conversion\Conversion
 */
public function addMediaConversion($name)
```

### performOnCollections

```
/**
 * Set the collection names on which this conversion must be performed.
 *
 * @param string $collectionNames,...
 *
 * @return $this
 */
public function performOnCollections($collectionNames)
```

### setManipulations

Note: you should pass an array with Glide parameters to `$manipulations`.

```
/**
 * Set the manipulations for this conversion.
 *
 * @param string $manipulations,...
 *
 * @return $this
 */
public function setManipulations($manipulations)
```

### queued

```
/**
 * Mark this conversion as one that should be queued.
 *
 * @return $this
 */
 public function queued()
```

### nonQueued

```
/**
 * Mark this conversion as one that should not be queued.
 *
 * @return $this
 */
public function nonQueued()
```

Glide convenience methods
-----------------------------------------------------------------------------------------------------------------------------------

### setWidth

```
/**
 * Set the target width.
 * Matches with Glide's 'w'-parameter.
 *
 * @param int $width
 *
 * @return $this
 *
 * @throws \Spatie\MediaLibrary\Exceptions\InvalidConversionParameter
 */
public function setWidth($width)
```

### setHeight

```
/*
 * Set the target height.
 * Matches with Glide's 'h'-parameter.
 *
 * @param int $height
 *
 * @return $this
 *
 * @throws \Spatie\MediaLibrary\Exceptions\InvalidConversionParameter
 */
```

### setFormat

```
/**
 * Set the target format.
 * Matches with Glide's 'fm'-parameter.
 *
 * @param string $format
 *
 * @return $this
 *
 * @throws \Spatie\MediaLibrary\Exceptions\InvalidConversionParameter
 */
 public function setFormat($format)
```

### setFit

```
/**
 * Set the target fit.
 * Matches with Glide's 'fit'-parameter.
 *
 * @param string $fit
 *
 * @return $this
 *
 * @throws \Spatie\MediaLibrary\Exceptions\InvalidConversionParameter
 */
 public function setFit($fit)
```

### setRectangle

```
/**
 * Set the target rectangle.
 * Matches with Glide's 'rect'-parameter.
 *
 * @param int $width
 * @param int $height
 * @param int $x
 * @param int $y
 *
 * @return $this
 *
 * @throws InvalidConversionParameter
 */
public function setRectangle($width, $height, $x, $y)
```