public class Sprite extends BitmovinResource
Constructor and Description |
---|
Sprite() |
Modifier and Type | Method and Description |
---|---|
Sprite |
addOutputsItem(EncodingOutput outputsItem) |
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`.
|
SpriteCreationMode |
getCreationMode()
The creation mode for the thumbnails in the Sprite.
|
Double |
getDistance()
Distance in the given unit between a screenshot
|
String |
getFilename()
Filename of the sprite image.
|
Integer |
getHeight()
Height of one thumbnail, either height or width are required fields.
|
Integer |
getHTiles()
Number of rows of images per file.
|
Integer |
getImagesPerFile()
Number of images per file.
|
SpriteJpegConfig |
getJpegConfig()
Additional configuration for JPEG sprite generation.
|
List<EncodingOutput> |
getOutputs()
Get outputs
|
String |
getSpriteName()
Name of the sprite image.
|
SpriteUnit |
getUnit()
Get unit
|
Integer |
getVTiles()
Number of columns of images per file.
|
String |
getVttName()
Filename of the vtt-file.
|
Integer |
getWidth()
Width of one 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 |
setCreationMode(SpriteCreationMode creationMode)
The creation mode for the thumbnails in the Sprite.
|
void |
setDistance(Double distance)
Distance in the given unit between a screenshot
|
void |
setFilename(String filename)
Filename of the sprite image.
|
void |
setHeight(Integer height)
Height of one thumbnail, either height or width are required fields.
|
void |
setHTiles(Integer hTiles)
Number of rows of images per file.
|
void |
setImagesPerFile(Integer imagesPerFile)
Number of images per file.
|
void |
setJpegConfig(SpriteJpegConfig jpegConfig)
Additional configuration for JPEG sprite generation.
|
void |
setOutputs(List<EncodingOutput> outputs)
Set outputs
|
void |
setSpriteName(String spriteName)
Name of the sprite image.
|
void |
setUnit(SpriteUnit unit)
Set unit
|
void |
setVTiles(Integer vTiles)
Number of columns of images per file.
|
void |
setVttName(String vttName)
Filename of the vtt-file.
|
void |
setWidth(Integer width)
Width of one 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 one 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 both are requiredpublic Integer getWidth()
public void setWidth(Integer width)
width
- Width of one 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 both are requiredpublic SpriteUnit getUnit()
public void setUnit(SpriteUnit unit)
unit
- public Double getDistance()
public void setDistance(Double distance)
distance
- Distance in the given unit between a screenshotpublic String getSpriteName()
public void setSpriteName(String spriteName)
spriteName
- Name of the sprite image. File extension \".jpg\"/\".jpeg\" or \".png\" is required. (required)public String getFilename()
public void setFilename(String filename)
filename
- Filename of the sprite image. If not set, spriteName will be used, but without an extension.public String getVttName()
public void setVttName(String vttName)
vttName
- Filename of the vtt-file. The file-extension \".vtt\" is required.public Sprite addOutputsItem(EncodingOutput outputsItem)
public List<EncodingOutput> getOutputs()
public void setOutputs(List<EncodingOutput> outputs)
outputs
- public Integer getImagesPerFile()
public void setImagesPerFile(Integer imagesPerFile)
imagesPerFile
- Number of images per file. If more images are generated than specified in this value, multiple sprites will be created. You can use the placeholder '%number%' in the spriteName to specify the naming policy. Either this property must be set or hTiles and vTiles.public Integer getHTiles()
public void setHTiles(Integer hTiles)
hTiles
- Number of rows of images per file. Has to be set together with vTiles. If this property and vTiles are set, the imagesPerFile property must not be set. It is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites. Only supported starting with encoder version `2.76.0`.
minimum: 1public Integer getVTiles()
public void setVTiles(Integer vTiles)
vTiles
- Number of columns of images per file. Has to be set together with hTiles. If this property and hTiles are set, the imagesPerFile property must not be set. It is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites. Only supported starting with encoder version `2.76.0`.
minimum: 1public SpriteJpegConfig getJpegConfig()
public void setJpegConfig(SpriteJpegConfig jpegConfig)
jpegConfig
- Additional configuration for JPEG sprite generation. If this property is set the extension of the file must be '.jpg.' or '.jpeg' Only supported starting with encoder version `2.76.0`public SpriteCreationMode getCreationMode()
public void setCreationMode(SpriteCreationMode creationMode)
creationMode
- The creation mode for the thumbnails in the Sprite. Two possible creation modes exist: generate thumbnails starting with the beginning of the video or after the first configured period. When using distance=10 and unit=SECONDS and INTERVAL_END, the first image of the sprite is from the second 10 of the video. When using distance=10 and unit=SECONDS and INTERVAL_START, the first image of the sprite is from the very start of the video, while the second image is from second 10 of the video. It is recommended to use 'INTERVAL_START' when using the sprites for trick play so that there is an additional thumbnail from the beginning of the video. Only supported starting with encoder version `2.76.0`.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.