StartEncodingRequest (bitmovin-api-sdk 1.190.0 API)

java.lang.Object
- com.bitmovin.api.sdk.model.StartEncodingRequest

public class StartEncodingRequest
extends Object

StartEncodingRequest

Constructor Summary

Constructors
Constructor and Description

StartEncodingRequest()

Constructors
Constructor and Description
`StartEncodingRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StartEncodingRequest`	`addPreviewDashManifestsItem(ManifestResource previewDashManifestsItem)`
`StartEncodingRequest`	`addPreviewHlsManifestsItem(ManifestResource previewHlsManifestsItem)`
`StartEncodingRequest`	`addVodDashManifestsItem(ManifestResource vodDashManifestsItem)`
`StartEncodingRequest`	`addVodHlsManifestsItem(ManifestResource vodHlsManifestsItem)`
`StartEncodingRequest`	`addVodSmoothManifestsItem(ManifestResource vodSmoothManifestsItem)`
`boolean`	`equals(Object o)`
`EncodingMode`	`getEncodingMode()` The pass mode of the encoding.
`Boolean`	`getHandleVariableInputFps()` Enable frame dropping/duplication to handle variable frames per seconds of video input streams
`ManifestGenerator`	`getManifestGenerator()` Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests).
`PerTitle`	`getPerTitle()` Per-Title settings
`List<ManifestResource>`	`getPreviewDashManifests()` DASH manifests to be generated for previewing while the encoding is still running.
`List<ManifestResource>`	`getPreviewHlsManifests()` HLS manifests to be generated for previewing while the encoding is still running.
`Scheduling`	`getScheduling()` Scheduling parameters of the encoding.
`Trimming`	`getTrimming()` Allows to encode only part of the input.
`Tweaks`	`getTweaks()` Special tweaks for your encoding job.
`List<ManifestResource>`	`getVodDashManifests()` DASH manifests to be generated right after encoding (just-in-time).
`List<ManifestResource>`	`getVodHlsManifests()` HLS manifests to be generated right after encoding (just-in-time).
`List<ManifestResource>`	`getVodSmoothManifests()` Smooth Streaming manifests to be generated right after encoding (just-in-time).
`int`	`hashCode()`
`void`	`setEncodingMode(EncodingMode encodingMode)` The pass mode of the encoding.
`void`	`setHandleVariableInputFps(Boolean handleVariableInputFps)` Enable frame dropping/duplication to handle variable frames per seconds of video input streams
`void`	`setManifestGenerator(ManifestGenerator manifestGenerator)` Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests).
`void`	`setPerTitle(PerTitle perTitle)` Per-Title settings
`void`	`setPreviewDashManifests(List<ManifestResource> previewDashManifests)` DASH manifests to be generated for previewing while the encoding is still running.
`void`	`setPreviewHlsManifests(List<ManifestResource> previewHlsManifests)` HLS manifests to be generated for previewing while the encoding is still running.
`void`	`setScheduling(Scheduling scheduling)` Scheduling parameters of the encoding.
`void`	`setTrimming(Trimming trimming)` Allows to encode only part of the input.
`void`	`setTweaks(Tweaks tweaks)` Special tweaks for your encoding job.
`void`	`setVodDashManifests(List<ManifestResource> vodDashManifests)` DASH manifests to be generated right after encoding (just-in-time).
`void`	`setVodHlsManifests(List<ManifestResource> vodHlsManifests)` HLS manifests to be generated right after encoding (just-in-time).
`void`	`setVodSmoothManifests(List<ManifestResource> vodSmoothManifests)` Smooth Streaming manifests to be generated right after encoding (just-in-time).
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartEncodingRequest
```
public StartEncodingRequest()
```
- Method Detail
  - getTrimming
```
public Trimming getTrimming()
```
    Allows to encode only part of the input. Defines start (offset) and duration of the desired section. This is not allowed when the Encoding uses any kind of Input Stream resource.
    
    Returns:
    
    trimming
  - setTrimming
```
public void setTrimming(Trimming trimming)
```
    Allows to encode only part of the input. Defines start (offset) and duration of the desired section. This is not allowed when the Encoding uses any kind of Input Stream resource.
    
    Parameters:
    
    trimming - Allows to encode only part of the input. Defines start (offset) and duration of the desired section. This is not allowed when the Encoding uses any kind of Input Stream resource.
  - getScheduling
```
public Scheduling getScheduling()
```
    Scheduling parameters of the encoding.
    
    Returns:
    
    scheduling
  - setScheduling
```
public void setScheduling(Scheduling scheduling)
```
    Scheduling parameters of the encoding.
    
    Parameters:
    
    scheduling - Scheduling parameters of the encoding.
  - getTweaks
```
public Tweaks getTweaks()
```
    Special tweaks for your encoding job.
    
    Returns:
    
    tweaks
  - setTweaks
```
public void setTweaks(Tweaks tweaks)
```
    Special tweaks for your encoding job.
    
    Parameters:
    
    tweaks - Special tweaks for your encoding job.
  - getHandleVariableInputFps
```
public Boolean getHandleVariableInputFps()
```
    Enable frame dropping/duplication to handle variable frames per seconds of video input streams
    
    Returns:
    
    handleVariableInputFps
  - setHandleVariableInputFps
```
public void setHandleVariableInputFps(Boolean handleVariableInputFps)
```
    Enable frame dropping/duplication to handle variable frames per seconds of video input streams
    
    Parameters:
    
    handleVariableInputFps - Enable frame dropping/duplication to handle variable frames per seconds of video input streams
  - getEncodingMode
```
public EncodingMode getEncodingMode()
```
    The pass mode of the encoding. Must only be set when `encodingMode` is not set on any codec configuration used by this encoding.
    
    Returns:
    
    encodingMode
  - setEncodingMode
```
public void setEncodingMode(EncodingMode encodingMode)
```
    The pass mode of the encoding. Must only be set when `encodingMode` is not set on any codec configuration used by this encoding.
    
    Parameters:
    
    encodingMode - The pass mode of the encoding. Must only be set when `encodingMode` is not set on any codec configuration used by this encoding.
  - addPreviewDashManifestsItem
```
public StartEncodingRequest addPreviewDashManifestsItem(ManifestResource previewDashManifestsItem)
```
  - getPreviewDashManifests
```
public List<ManifestResource> getPreviewDashManifests()
```
    DASH manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
    
    Returns:
    
    previewDashManifests
  - setPreviewDashManifests
```
public void setPreviewDashManifests(List<ManifestResource> previewDashManifests)
```
    DASH manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
    
    Parameters:
    
    previewDashManifests - DASH manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
  - addPreviewHlsManifestsItem
```
public StartEncodingRequest addPreviewHlsManifestsItem(ManifestResource previewHlsManifestsItem)
```
  - getPreviewHlsManifests
```
public List<ManifestResource> getPreviewHlsManifests()
```
    HLS manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
    
    Returns:
    
    previewHlsManifests
  - setPreviewHlsManifests
```
public void setPreviewHlsManifests(List<ManifestResource> previewHlsManifests)
```
    HLS manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
    
    Parameters:
    
    previewHlsManifests - HLS manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
  - addVodDashManifestsItem
```
public StartEncodingRequest addVodDashManifestsItem(ManifestResource vodDashManifestsItem)
```
  - getVodDashManifests
```
public List<ManifestResource> getVodDashManifests()
```
    DASH manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
    
    Returns:
    
    vodDashManifests
  - setVodDashManifests
```
public void setVodDashManifests(List<ManifestResource> vodDashManifests)
```
    DASH manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
    
    Parameters:
    
    vodDashManifests - DASH manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
  - addVodHlsManifestsItem
```
public StartEncodingRequest addVodHlsManifestsItem(ManifestResource vodHlsManifestsItem)
```
  - getVodHlsManifests
```
public List<ManifestResource> getVodHlsManifests()
```
    HLS manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
    
    Returns:
    
    vodHlsManifests
  - setVodHlsManifests
```
public void setVodHlsManifests(List<ManifestResource> vodHlsManifests)
```
    HLS manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
    
    Parameters:
    
    vodHlsManifests - HLS manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
  - addVodSmoothManifestsItem
```
public StartEncodingRequest addVodSmoothManifestsItem(ManifestResource vodSmoothManifestsItem)
```
  - getVodSmoothManifests
```
public List<ManifestResource> getVodSmoothManifests()
```
    Smooth Streaming manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
    
    Returns:
    
    vodSmoothManifests
  - setVodSmoothManifests
```
public void setVodSmoothManifests(List<ManifestResource> vodSmoothManifests)
```
    Smooth Streaming manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
    
    Parameters:
    
    vodSmoothManifests - Smooth Streaming manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
  - getManifestGenerator
```
public ManifestGenerator getManifestGenerator()
```
    Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.
    
    Returns:
    
    manifestGenerator
  - setManifestGenerator
```
public void setManifestGenerator(ManifestGenerator manifestGenerator)
```
    Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.
    
    Parameters:
    
    manifestGenerator - Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.
  - getPerTitle
```
public PerTitle getPerTitle()
```
    Per-Title settings
    
    Returns:
    
    perTitle
  - setPerTitle
```
public void setPerTitle(PerTitle perTitle)
```
    Per-Title settings
    
    Parameters:
    
    perTitle - Per-Title settings
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class StartEncodingRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StartEncodingRequest

Method Detail

getTrimming

setTrimming

getScheduling

setScheduling

getTweaks

setTweaks

getHandleVariableInputFps

setHandleVariableInputFps

getEncodingMode

setEncodingMode

addPreviewDashManifestsItem

getPreviewDashManifests

setPreviewDashManifests

addPreviewHlsManifestsItem

getPreviewHlsManifests

setPreviewHlsManifests

addVodDashManifestsItem

getVodDashManifests

setVodDashManifests

addVodHlsManifestsItem

getVodHlsManifests

setVodHlsManifests

addVodSmoothManifestsItem

getVodSmoothManifests

setVodSmoothManifests

getManifestGenerator

setManifestGenerator

getPerTitle

setPerTitle

equals

hashCode

toString