com.bitmovin.api.sdk.model

Class VideoConfiguration

java.lang.Object

com.bitmovin.api.sdk.model.BitmovinResponse

com.bitmovin.api.sdk.model.BitmovinResource

com.bitmovin.api.sdk.model.CodecConfiguration

com.bitmovin.api.sdk.model.VideoConfiguration

Direct Known Subclasses:

Av1VideoConfiguration, H262VideoConfiguration, H264VideoConfiguration, H265VideoConfiguration, Vp8VideoConfiguration, Vp9VideoConfiguration

public class VideoConfiguration
extends CodecConfiguration

VideoConfiguration

Constructor Summary

Constructors

Constructor and Description
VideoConfiguration()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Long	getBitrate() Target bitrate for the encoded video in bps.
ColorConfig	getColorConfig() Get colorConfig
DisplayAspectRatio	getDisplayAspectRatio() Specifies a display aspect ratio (DAR) to be enforced.
EncodingMode	getEncodingMode() The mode of the encoding.
Integer	getHeight() Height of the encoded video in pixels
PixelFormat	getPixelFormat() Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.
Double	getRate() Target frame rate of the encoded video.
Integer	getSampleAspectRatioDenominator() The denominator of the sample aspect ratio (also known as pixel aspect ratio).
Integer	getSampleAspectRatioNumerator() The numerator of the sample aspect ratio (also known as pixel aspect ratio).
Integer	getWidth() Width of the encoded video in pixels
int	hashCode()
void	setBitrate(Long bitrate) Target bitrate for the encoded video in bps.
void	setColorConfig(ColorConfig colorConfig) Set colorConfig
void	setDisplayAspectRatio(DisplayAspectRatio displayAspectRatio) Specifies a display aspect ratio (DAR) to be enforced.
void	setEncodingMode(EncodingMode encodingMode) The mode of the encoding.
void	setHeight(Integer height) Height of the encoded video in pixels
void	setPixelFormat(PixelFormat pixelFormat) Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.
void	setRate(Double rate) Target frame rate of the encoded video.
void	setSampleAspectRatioDenominator(Integer sampleAspectRatioDenominator) The denominator of the sample aspect ratio (also known as pixel aspect ratio).
void	setSampleAspectRatioNumerator(Integer sampleAspectRatioNumerator) The numerator of the sample aspect ratio (also known as pixel aspect ratio).
void	setWidth(Integer width) Width of the encoded video in pixels
String	toString()

Methods inherited from class com.bitmovin.api.sdk.model.BitmovinResource

getCreatedAt, getCustomData, getDescription, getModifiedAt, getName, putCustomDataItem, setCustomData, setDescription, setName

Methods inherited from class com.bitmovin.api.sdk.model.BitmovinResponse

getId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VideoConfiguration

public VideoConfiguration()

Method Detail

getWidth

public Integer getWidth()

Width of the encoded video in pixels

Returns:

width

setWidth

public void setWidth(Integer width)

Width of the encoded video in pixels

Parameters:

width - Width of the encoded video in pixels

getHeight

public Integer getHeight()

Height of the encoded video in pixels

Returns:

height

setHeight

public void setHeight(Integer height)

Height of the encoded video in pixels

Parameters:

height - Height of the encoded video in pixels

getBitrate

public Long getBitrate()

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

Returns:

bitrate

setBitrate

public void setBitrate(Long bitrate)

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

Parameters:

bitrate - Target bitrate for the encoded video in bps. Either bitrate or crf is required.

getRate

public Double getRate()

Target frame rate of the encoded video. Must be set for live encodings

Returns:

rate

setRate

public void setRate(Double rate)

Target frame rate of the encoded video. Must be set for live encodings

Parameters:

rate - Target frame rate of the encoded video. Must be set for live encodings

getPixelFormat

public PixelFormat getPixelFormat()

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

Returns:

pixelFormat

setPixelFormat

public void setPixelFormat(PixelFormat pixelFormat)

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

Parameters:

pixelFormat - Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

getColorConfig

public ColorConfig getColorConfig()

Get colorConfig

Returns:

colorConfig

setColorConfig

public void setColorConfig(ColorConfig colorConfig)

Set colorConfig

Parameters:

colorConfig -

getSampleAspectRatioNumerator

public Integer getSampleAspectRatioNumerator()

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

Returns:

sampleAspectRatioNumerator

setSampleAspectRatioNumerator

public void setSampleAspectRatioNumerator(Integer sampleAspectRatioNumerator)

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

Parameters:

sampleAspectRatioNumerator - The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

getSampleAspectRatioDenominator

public Integer getSampleAspectRatioDenominator()

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

Returns:

sampleAspectRatioDenominator

setSampleAspectRatioDenominator

public void setSampleAspectRatioDenominator(Integer sampleAspectRatioDenominator)

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

Parameters:

sampleAspectRatioDenominator - The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

getDisplayAspectRatio

public DisplayAspectRatio getDisplayAspectRatio()

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

Returns:

displayAspectRatio

setDisplayAspectRatio

public void setDisplayAspectRatio(DisplayAspectRatio displayAspectRatio)

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

Parameters:

displayAspectRatio - Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

getEncodingMode

public EncodingMode getEncodingMode()

The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.

Returns:

encodingMode

setEncodingMode

public void setEncodingMode(EncodingMode encodingMode)

The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.

Parameters:

encodingMode - The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.

equals

public boolean equals(Object o)

Overrides:

equals in class CodecConfiguration

hashCode

public int hashCode()

Overrides:

hashCode in class CodecConfiguration

toString

public String toString()

Overrides:

toString in class CodecConfiguration