EncodingAttributes (Jave core package 2.7.3 API)

java.lang.Object
- ws.schild.jave.EncodingAttributes

All Implemented Interfaces:

Serializable
```
public class EncodingAttributes
extends Object
implements Serializable
```
Attributes controlling the encoding process.

Author:

Carlo Pelliccia

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

EncodingAttributes()

Constructors
Constructor and Description
`EncodingAttributes()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AudioAttributes`	`getAudioAttributes()` Returns the attributes for the encoding of the audio stream in the target multimedia file.
`int`	`getDecodingThreads()` Number of threads to use for decoding (if supported by codec) -1 means use default of ffmpeg
`Float`	`getDuration()` Returns the duration (seconds) of the re-encoded stream.
`int`	`getEncodingThreads()` Number of threads to use for encoding (if supported by codec) -1 means use default of ffmpeg
`int`	`getFilterThreads()`
`String`	`getFormat()` Returns the format name for the encoded target multimedia file.
`Float`	`getOffset()` Returns the start offset time (seconds).
`VideoAttributes`	`getVideoAttributes()` Returns the attributes for the encoding of the video stream in the target multimedia file.
`boolean`	`isMapMetaData()`
`EncodingAttributes`	`setAudioAttributes(AudioAttributes audioAttributes)` Sets the attributes for the encoding of the audio stream in the target multimedia file.
`EncodingAttributes`	`setDecodingThreads(int decodingThreads)` Number of threads to use for decoding (if supported by codec) -1 means use default of ffmpeg
`EncodingAttributes`	`setDuration(Float duration)` Sets the duration (seconds) of the re-encoded stream.
`EncodingAttributes`	`setEncodingThreads(int encodingThreads)` Number of threads to use for encoding (if supported by codec) -1 means use default of ffmpeg
`EncodingAttributes`	`setFilterThreads(int filterThreads)` ffmpeg uses multiple cores for filtering
`EncodingAttributes`	`setFormat(String format)` Sets the format name for the encoded target multimedia file.
`EncodingAttributes`	`setMapMetaData(boolean mapMetaData)` Copy over meta data from original file to new output if possible
`EncodingAttributes`	`setOffset(Float offset)` Sets the start offset time (seconds).
`EncodingAttributes`	`setVideoAttributes(VideoAttributes videoAttributes)` Sets the attributes for the encoding of the video stream in the target multimedia file.
`String`	`toString()`

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

- Constructor Detail
  - EncodingAttributes
```
public EncodingAttributes()
```
- Method Detail
  - getFormat
```
public String getFormat()
```
    Returns the format name for the encoded target multimedia file.
    
    Returns:
    
    The format name for the encoded target multimedia file.
  - setFormat
```
public EncodingAttributes setFormat(String format)
```
    Sets the format name for the encoded target multimedia file. Be sure this format is supported (see Encoder.getSupportedEncodingFormats().
    
    Parameters:
    
    format - The format name for the encoded target multimedia file.
    
    Returns:
    
    this instance
  - getOffset
```
public Float getOffset()
```
    Returns the start offset time (seconds).
    
    Returns:
    
    The start offset time (seconds).
  - setOffset
```
public EncodingAttributes setOffset(Float offset)
```
    Sets the start offset time (seconds). If null or not specified no start offset will be applied.
    
    Parameters:
    
    offset - The start offset time (seconds).
    
    Returns:
    
    this instance
  - getDuration
```
public Float getDuration()
```
    Returns the duration (seconds) of the re-encoded stream.
    
    Returns:
    
    The duration (seconds) of the re-encoded stream.
  - setDuration
```
public EncodingAttributes setDuration(Float duration)
```
    Sets the duration (seconds) of the re-encoded stream. If null or not specified the source stream, starting from the offset, will be completely re-encoded in the target stream.
    
    Parameters:
    
    duration - The duration (seconds) of the re-encoded stream.
    
    Returns:
    
    this instance
  - getAudioAttributes
```
public AudioAttributes getAudioAttributes()
```
    Returns the attributes for the encoding of the audio stream in the target multimedia file.
    
    Returns:
    
    The attributes for the encoding of the audio stream in the target multimedia file.
  - setAudioAttributes
```
public EncodingAttributes setAudioAttributes(AudioAttributes audioAttributes)
```
    Sets the attributes for the encoding of the audio stream in the target multimedia file. If null of not specified no audio stream will be encoded. It cannot be null if also the video field is null.
    
    Parameters:
    
    audioAttributes - The attributes for the encoding of the audio stream in the target multimedia file.
    
    Returns:
    
    this instance
  - getVideoAttributes
```
public VideoAttributes getVideoAttributes()
```
    Returns the attributes for the encoding of the video stream in the target multimedia file.
    
    Returns:
    
    The attributes for the encoding of the video stream in the target multimedia file.
  - setVideoAttributes
```
public EncodingAttributes setVideoAttributes(VideoAttributes videoAttributes)
```
    Sets the attributes for the encoding of the video stream in the target multimedia file. If null of not specified no video stream will be encoded. It cannot be null if also the audio field is null.
    
    Parameters:
    
    videoAttributes - The attributes for the encoding of the video stream in the target multimedia file.
    
    Returns:
    
    this instance
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isMapMetaData
```
public boolean isMapMetaData()
```
    Returns:
    
    the mapMetaData
  - setMapMetaData
```
public EncodingAttributes setMapMetaData(boolean mapMetaData)
```
    Copy over meta data from original file to new output if possible
    
    Parameters:
    
    mapMetaData - the mapMetaData to set
    
    Returns:
    
    this instance
  - getFilterThreads
```
public int getFilterThreads()
```
    Returns:
    
    Maximum number of cores/cpus to use for filtering -1 means use default of ffmpeg
  - setFilterThreads
```
public EncodingAttributes setFilterThreads(int filterThreads)
```
    ffmpeg uses multiple cores for filtering
    
    Parameters:
    
    filterThreads - Maximum number of cores/cpus to use -1 means use default of ffmpeg
    
    Returns:
    
    this instance
  - getDecodingThreads
```
public int getDecodingThreads()
```
    Number of threads to use for decoding (if supported by codec) -1 means use default of ffmpeg
    
    Returns:
    
    the decodingThreads
  - setDecodingThreads
```
public EncodingAttributes setDecodingThreads(int decodingThreads)
```
    Number of threads to use for decoding (if supported by codec) -1 means use default of ffmpeg
    
    Parameters:
    
    decodingThreads - the decodingThreads to set
    
    Returns:
    
    this instance
  - getEncodingThreads
```
public int getEncodingThreads()
```
    Number of threads to use for encoding (if supported by codec) -1 means use default of ffmpeg
    
    Returns:
    
    the encodingThreads
  - setEncodingThreads
```
public EncodingAttributes setEncodingThreads(int encodingThreads)
```
    Number of threads to use for encoding (if supported by codec) -1 means use default of ffmpeg
    
    Parameters:
    
    encodingThreads - the encodingThreads to set
    
    Returns:
    
    this instance

Class EncodingAttributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EncodingAttributes

Method Detail

getFormat

setFormat

getOffset

setOffset

getDuration

setDuration

getAudioAttributes

setAudioAttributes

getVideoAttributes

setVideoAttributes

toString

isMapMetaData

setMapMetaData

getFilterThreads

setFilterThreads

getDecodingThreads

setDecodingThreads

getEncodingThreads

setEncodingThreads