public class Thumbnail extends BitmovinResource
Constructor and Description |
---|
Thumbnail() |
Modifier and Type | Method and Description |
---|---|
Thumbnail |
addOutputsItem(EncodingOutput outputsItem) |
Thumbnail |
addPositionsItem(Double positionsItem) |
boolean |
equals(Object o) |
ThumbnailAspectMode |
getAspectMode()
Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version `2.85.0`.
|
Integer |
getHeight()
Height of the thumbnail, either height or width are required fields.
|
Double |
getInterval()
The interval in which to create thumbnails.
|
List<EncodingOutput> |
getOutputs()
Get outputs
|
String |
getPattern()
Pattern which describes the thumbnail filenames.
|
List<Double> |
getPositions()
Position in the unit where the thumbnail should be created from.
|
ThumbnailUnit |
getUnit()
Unit of the values in the positions array.
|
Integer |
getWidth()
Width of the thumbnail, either height or width are required fields.
|
int |
hashCode() |
void |
setAspectMode(ThumbnailAspectMode aspectMode)
Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version `2.85.0`.
|
void |
setHeight(Integer height)
Height of the thumbnail, either height or width are required fields.
|
void |
setInterval(Double interval)
The interval in which to create thumbnails.
|
void |
setOutputs(List<EncodingOutput> outputs)
Set outputs
|
void |
setPattern(String pattern)
Pattern which describes the thumbnail filenames.
|
void |
setPositions(List<Double> positions)
Position in the unit where the thumbnail should be created from.
|
void |
setUnit(ThumbnailUnit unit)
Unit of the values in the positions array.
|
void |
setWidth(Integer width)
Width of the thumbnail, either height or width are required fields.
|
String |
toString() |
getCreatedAt, getCustomData, getDescription, getModifiedAt, getName, putCustomDataItem, setCustomData, setDescription, setName
getId
public Integer getHeight()
public void setHeight(Integer height)
height
- Height of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported and mandatory.public Integer getWidth()
public void setWidth(Integer width)
width
- Width of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supportedpublic String getPattern()
public void setPattern(String pattern)
pattern
- Pattern which describes the thumbnail filenames. For example with thumbnail-%number%.png as pattern and 3 positions: thumbnail-3_0.png, thumbnail-5_0.png and thumbnail-25_5.png. (The number represents the position in the source video in seconds, in the previous example the first filename represents the thumbnail at 3s, the second one at 5s and the third one at 25.5s). (required)public Double getInterval()
public void setInterval(Double interval)
interval
- The interval in which to create thumbnails. In seconds (E.g. a value of 4 means create a thumbnail every 4 seconds). Mutually exclusive with positions/unit. Has to be equal to or greater than 1.public List<Double> getPositions()
public void setPositions(List<Double> positions)
positions
- Position in the unit where the thumbnail should be created from. Mutually exclusive with interval.public Thumbnail addOutputsItem(EncodingOutput outputsItem)
public List<EncodingOutput> getOutputs()
public void setOutputs(List<EncodingOutput> outputs)
outputs
- public ThumbnailUnit getUnit()
public void setUnit(ThumbnailUnit unit)
unit
- Unit of the values in the positions array.public ThumbnailAspectMode getAspectMode()
public void setAspectMode(ThumbnailAspectMode aspectMode)
aspectMode
- Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version `2.85.0`.public boolean equals(Object o)
equals
in class BitmovinResource
public int hashCode()
hashCode
in class BitmovinResource
public String toString()
toString
in class BitmovinResource
Copyright © 2022. All rights reserved.