Coder (humble-video-noarch 0.3.0 API)

java.lang.Object
- io.humble.ferry.RefCounted
- - io.humble.video.Configurable
  - - io.humble.video.Coder

Direct Known Subclasses:

Decoder, Encoder
```
public class Coder
extends Configurable
```
An object that either converts MediaRaw objects into MediaEncoded
objects (called an Encoder), or converts in the reverse direction (called
a Decoder).

Although this object might seem very sparse, use the methods on Configurable
to see the vast array of options that can be get/set on it.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Coder.Flag

static class Coder.Flag2

static class Coder.State
The state that a Coder can be in.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Coder.Flag`
`static class`	`Coder.Flag2`
`static class`	`Coder.State` The state that a Coder can be in.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Coder`	`copyReference()` Create a new Coder object that is actually referring to the exact same underlying native object.
`boolean`	`equals(Object obj)` Compares two values, returning true if the underlying objects in native code are the same object.
`AudioChannel.Layout`	`getChannelLayout()` Get the channel layout.
`int`	`getChannels()` Get the number of channels in this audio stream
`Codec`	`getCodec()` The Codec this StreamCoder will use.
`Codec.ID`	`getCodecID()` A short hand for getCodec().getID().
`MediaDescriptor.Type`	`getCodecType()` A short hand for getCodec().getType().
`int`	`getFlag(Coder.Flag flag)` Check if a given flag is set.
`int`	`getFlag2(Coder.Flag2 flag)` Check if a given flag2 flag is set.
`int`	`getFlags()` Get the 32-bit compliment of all flags.
`int`	`getFlags2()` Get the 32-bit compliment of all flags 2 flags
`int`	`getFrameCount()` Get the number of frames encoded/decoded so far. If encoding or decoding has an error, this count is not incremented.
`int`	`getFrameSize()` Number of samples per channel in an audio frame. - encoding: Each submitted frame except the last must contain exactly frame_size samples per channel. May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the frame size is not restricted. - decoding: may be set by some decoders to indicate constant frame size
`int`	`getHeight()` The height, in pixels.
`PixelFormat.Type`	`getPixelFormat()` For Video streams, get the Pixel Format in use by the stream.
`AudioFormat.Type`	`getSampleFormat()` Get the audio sample format.
`int`	`getSampleRate()` Get the sample rate we use for this coder.
`Coder.State`	`getState()` Get the state of this coder.
`Rational`	`getTimeBase()` Get the time base this stream will ENCODE in, or the time base we detect while DECODING.
`int`	`getWidth()` The width, in pixels.
`int`	`hashCode()` Get a hashable value for this object.
`void`	`open(KeyValueBag inputOptions, KeyValueBag unsetOptions)` Open this Coder, using the given bag of Codec-specific options.
`void`	`setChannelLayout(AudioChannel.Layout layout)` Set the channel layout
`void`	`setChannels(int channels)` Set the number of channels to use when ENCODING.
`void`	`setFlag(Coder.Flag flag, boolean value)` Set a flag to true or false.
`void`	`setFlag2(Coder.Flag2 flag, boolean value)` Set a flag2 to true or false.
`void`	`setFlags(int newVal)` Set a new bitmask of all Flag values (bit xored together).
`void`	`setFlags2(int newVal)` Set a new bitmask of all Flag2 values (bit xored together).
`void`	`setHeight(int height)` Set the height, in pixels.
`void`	`setPixelFormat(PixelFormat.Type pixelFmt)` Set the pixel format to ENCODE with.
`void`	`setSampleFormat(AudioFormat.Type format)` Set the sample format when ENCODING.
`void`	`setSampleRate(int sampleRate)` Set the sample rate to use when ENCODING.
`void`	`setTimeBase(Rational newTimeBase)` Set the time base we'll use to ENCODE with.
`void`	`setWidth(int width)` Set the width, in pixels
`String`	`toString()`

Methods inherited from class io.humble.video.Configurable
getNumProperties, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsInt, getPropertyAsLong, getPropertyAsRational, getPropertyAsString, getPropertyMetaData, getPropertyMetaData, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty

Methods inherited from class io.humble.ferry.RefCounted
delete, getCurrentRefCount

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

- Method Detail
  - copyReference
```
public Coder copyReference()
```
    Create a new Coder object that is actually referring to the exact same underlying native object.
    
    Overrides:
    
    copyReference in class Configurable
    
    Returns:
    
    the new Java object.
  - equals
```
public boolean equals(Object obj)
```
    Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.
    
    Overrides:
    
    equals in class Configurable
    
    Returns:
    
    True if the underlying native object is the same. False otherwise.
  - hashCode
```
public int hashCode()
```
    Get a hashable value for this object.
    
    Overrides:
    
    hashCode in class Configurable
    
    Returns:
    
    the hashable value.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - open
```
public void open(KeyValueBag inputOptions,
                 KeyValueBag unsetOptions)
```
    Open this Coder, using the given bag of Codec-specific options.
    
    Parameters:
    
    inputOptions - If non-null, a bag of codec-specific options.
    
    unsetOptions - If non-null, the bag will be emptied and then filled with
    the options in inputOptions that were not set.
  - getCodec
```
public Codec getCodec()
```
    The Codec this StreamCoder will use.
    
    Returns:
    
    The Codec used by this StreamCoder, or 0 (null) if none.
  - getCodecType
```
public MediaDescriptor.Type getCodecType()
```
    A short hand for getCodec().getType().
    
    Returns:
    
    The Type of the Codec we'll use.
  - getCodecID
```
public Codec.ID getCodecID()
```
    A short hand for getCodec().getID().
    
    Returns:
    
    The ID of the Codec we'll use.
  - getHeight
```
public int getHeight()
```
    The height, in pixels.
    
    Returns:
    
    The height of the video frames in the attached stream
    or -1 if an audio stream, or we cannot determine the height.
  - setHeight
```
public void setHeight(int height)
```
    Set the height, in pixels.
    
    Parameters:
    
    height - Sets the height of video frames we'll encode. No-op when DECODING.
    
    See Also:
  - getWidth
```
public int getWidth()
```
    The width, in pixels.
    
    Returns:
    
    The width of the video frames in the attached stream
    or -1 if an audio stream, or we cannot determine the width.
  - setWidth
```
public void setWidth(int width)
```
    Set the width, in pixels
    
    Parameters:
    
    width - Sets the width of video frames we'll encode. No-op when DECODING.
    
    See Also:
  - getPixelFormat
```
public PixelFormat.Type getPixelFormat()
```
    For Video streams, get the Pixel Format in use by the stream.
    
    Returns:
    
    the Pixel format, or PixelFormat::PIX_FMT_NONE if audio.
  - setPixelFormat
```
public void setPixelFormat(PixelFormat.Type pixelFmt)
```
    Set the pixel format to ENCODE with. Ignored if audio or
    DECODING.
    
    Parameters:
    
    pixelFmt - Pixel format to use.
  - getSampleRate
```
public int getSampleRate()
```
    Get the sample rate we use for this coder.
    
    Returns:
    
    The sample rate (in Hz) we use for this stream, or -1 if unknown or video.
  - setSampleRate
```
public void setSampleRate(int sampleRate)
```
    Set the sample rate to use when ENCODING. Ignored if DECODING
    or a non-audio stream.
    
    Parameters:
    
    sampleRate - New sample rate (in Hz) to use.
  - getSampleFormat
```
public AudioFormat.Type getSampleFormat()
```
    Get the audio sample format.
    
    Returns:
    
    The sample format of samples for encoding/decoding.
  - setSampleFormat
```
public void setSampleFormat(AudioFormat.Type format)
```
    Set the sample format when ENCODING. Ignored if DECODING
    or if the coder is already open.
    
    Parameters:
    
    format - The sample format.
  - getChannels
```
public int getChannels()
```
    Get the number of channels in this audio stream
    
    Returns:
    
    The sample rate (in Hz) we use for this stream, or 0 if unknown.
  - setChannels
```
public void setChannels(int channels)
```
    Set the number of channels to use when ENCODING. Ignored if a
    non audio stream, or if DECODING.
    
    Parameters:
    
    channels - The number of channels we'll encode with.
  - getChannelLayout
```
public AudioChannel.Layout getChannelLayout()
```
    Get the channel layout.
  - setChannelLayout
```
public void setChannelLayout(AudioChannel.Layout layout)
```
    Set the channel layout
  - getTimeBase
```
public Rational getTimeBase()
```
    Get the time base this stream will ENCODE in, or the time base we
    detect while DECODING.
    
    Returns:
    
    The time base this StreamCoder is using.
  - setTimeBase
```
public void setTimeBase(Rational newTimeBase)
```
    Set the time base we'll use to ENCODE with. A no-op when DECODING.
    
    As a convenience, we forward this call to the Stream#setTimeBase()
    method.
    
    Parameters:
    
    newTimeBase - The new time base to use.
    
    See Also:
  - getState
```
public Coder.State getState()
```
    Get the state of this coder.
  - getFrameCount
```
public int getFrameCount()
```
    Get the number of frames encoded/decoded so far.
    If encoding or decoding has an error, this count is not incremented.
  - getFrameSize
```
public int getFrameSize()
```
    Number of samples per channel in an audio frame.
    
    - encoding: Each submitted frame
    except the last must contain exactly frame_size samples per channel.
    May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
    frame size is not restricted.
    - decoding: may be set by some decoders to indicate constant frame size
    
    Returns:
    
    number of samples per channel.
  - getFlags
```
public int getFlags()
```
    Get the 32-bit compliment of all flags.
  - getFlag
```
public int getFlag(Coder.Flag flag)
```
    Check if a given flag is set.
  - getFlags2
```
public int getFlags2()
```
    Get the 32-bit compliment of all flags 2 flags
  - getFlag2
```
public int getFlag2(Coder.Flag2 flag)
```
    Check if a given flag2 flag is set.
  - setFlags
```
public void setFlags(int newVal)
```
    Set a new bitmask of all Flag values (bit xored together).
  - setFlag
```
public void setFlag(Coder.Flag flag,
                    boolean value)
```
    Set a flag to true or false.
  - setFlags2
```
public void setFlags2(int newVal)
```
    Set a new bitmask of all Flag2 values (bit xored together).
  - setFlag2
```
public void setFlag2(Coder.Flag2 flag,
                     boolean value)
```
    Set a flag2 to true or false.

Class Coder

Nested Class Summary

Method Summary

Methods inherited from class io.humble.video.Configurable

Methods inherited from class io.humble.ferry.RefCounted

Methods inherited from class java.lang.Object

Method Detail

copyReference

equals

hashCode

toString

open

getCodec

getCodecType

getCodecID

getHeight

setHeight

getWidth

setWidth

getPixelFormat

setPixelFormat

getSampleRate

setSampleRate

getSampleFormat

setSampleFormat

getChannels

setChannels

getChannelLayout

setChannelLayout

getTimeBase

setTimeBase

getState

getFrameCount

getFrameSize

getFlags

getFlag

getFlags2

getFlag2

setFlags

setFlag

setFlags2

setFlag2