AVOption (JavaCPP Presets for FFmpeg 5.1.2-1.5.8 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.ffmpeg.avutil.AVOption

All Implemented Interfaces:: AutoCloseable

@Properties(inherit=avutil.class)
public class AVOption
extends Pointer

AVOption

Nested Class Summary
- Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer
  Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AV_OPT_FLAG_AUDIO_PARAM`
`static int`	`AV_OPT_FLAG_BSF_PARAM` a generic parameter which can be set by the user for bit stream filtering
`static int`	`AV_OPT_FLAG_CHILD_CONSTS` set if option constants can also reside in child objects
`static int`	`AV_OPT_FLAG_DECODING_PARAM` a generic parameter which can be set by the user for demuxing or decoding
`static int`	`AV_OPT_FLAG_DEPRECATED` set if option is deprecated, users should refer to AVOption.help text for more information
`static int`	`AV_OPT_FLAG_ENCODING_PARAM` a generic parameter which can be set by the user for muxing or encoding
`static int`	`AV_OPT_FLAG_EXPORT` The option is intended for exporting values to the caller.
`static int`	`AV_OPT_FLAG_FILTERING_PARAM` a generic parameter which can be set by the user for filtering
`static int`	`AV_OPT_FLAG_READONLY` The option may not be set through the AVOptions API, only read.
`static int`	`AV_OPT_FLAG_RUNTIME_PARAM` a generic parameter which can be set by the user at runtime
`static int`	`AV_OPT_FLAG_SUBTITLE_PARAM`
`static int`	`AV_OPT_FLAG_VIDEO_PARAM`

Fields inherited from class org.bytedeco.javacpp.Pointer
address, capacity, limit, position

Constructor Summary

Constructors
Constructor and Description

AVOption()
Default native constructor.

AVOption(long size)
Native array allocator.

AVOption(Pointer p)
Pointer cast constructor.

Constructors
Constructor and Description
`AVOption()` Default native constructor.
`AVOption(long size)` Native array allocator.
`AVOption(Pointer p)` Pointer cast constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`default_val_dbl()`
`AVOption`	`default_val_dbl(double setter)`
`long`	`default_val_i64()` the default value for scalar options
`AVOption`	`default_val_i64(long setter)`
`AVRational`	`default_val_q()`
`AVOption`	`default_val_q(AVRational setter)`
`BytePointer`	`default_val_str()`
`AVOption`	`default_val_str(BytePointer setter)`
`int`	`flags()`
`AVOption`	`flags(int setter)`
`AVOption`	`getPointer(long i)`
`BytePointer`	`help()` short English help text \todo What about other languages?
`AVOption`	`help(BytePointer setter)`
`double`	`max()` maximum valid value for the option
`AVOption`	`max(double setter)`
`double`	`min()` minimum valid value for the option
`AVOption`	`min(double setter)`
`BytePointer`	`name()`
`AVOption`	`name(BytePointer setter)`
`int`	`offset()` The offset relative to the context structure where the option value is stored.
`AVOption`	`offset(int setter)`
`AVOption`	`position(long position)`
`int`	`type()`
`AVOption`	`type(int setter)`
`BytePointer`	`unit()` The logical unit to which the option belongs.
`AVOption`	`unit(BytePointer setter)`

Methods inherited from class org.bytedeco.javacpp.Pointer
address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

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

- Field Detail
  - AV_OPT_FLAG_ENCODING_PARAM
```
public static final int AV_OPT_FLAG_ENCODING_PARAM
```
    a generic parameter which can be set by the user for muxing or encoding
    
    See Also:
    
    Constant Field Values
  - AV_OPT_FLAG_DECODING_PARAM
```
public static final int AV_OPT_FLAG_DECODING_PARAM
```
    a generic parameter which can be set by the user for demuxing or decoding
    
    See Also:
    
    Constant Field Values
  - AV_OPT_FLAG_AUDIO_PARAM
```
public static final int AV_OPT_FLAG_AUDIO_PARAM
```
    See Also:
    
    Constant Field Values
  - AV_OPT_FLAG_VIDEO_PARAM
```
public static final int AV_OPT_FLAG_VIDEO_PARAM
```
    See Also:
    
    Constant Field Values
  - AV_OPT_FLAG_SUBTITLE_PARAM
```
public static final int AV_OPT_FLAG_SUBTITLE_PARAM
```
    See Also:
    
    Constant Field Values
  - AV_OPT_FLAG_EXPORT
```
public static final int AV_OPT_FLAG_EXPORT
```
    The option is intended for exporting values to the caller.
    
    See Also:
    
    Constant Field Values
  - AV_OPT_FLAG_READONLY
```
public static final int AV_OPT_FLAG_READONLY
```
    The option may not be set through the AVOptions API, only read. This flag only makes sense when AV_OPT_FLAG_EXPORT is also set.
    
    See Also:
    
    Constant Field Values
  - AV_OPT_FLAG_BSF_PARAM
```
public static final int AV_OPT_FLAG_BSF_PARAM
```
    a generic parameter which can be set by the user for bit stream filtering
    
    See Also:
    
    Constant Field Values
  - AV_OPT_FLAG_RUNTIME_PARAM
```
public static final int AV_OPT_FLAG_RUNTIME_PARAM
```
    a generic parameter which can be set by the user at runtime
    
    See Also:
    
    Constant Field Values
  - AV_OPT_FLAG_FILTERING_PARAM
```
public static final int AV_OPT_FLAG_FILTERING_PARAM
```
    a generic parameter which can be set by the user for filtering
    
    See Also:
    
    Constant Field Values
  - AV_OPT_FLAG_DEPRECATED
```
public static final int AV_OPT_FLAG_DEPRECATED
```
    set if option is deprecated, users should refer to AVOption.help text for more information
    
    See Also:
    
    Constant Field Values
  - AV_OPT_FLAG_CHILD_CONSTS
```
public static final int AV_OPT_FLAG_CHILD_CONSTS
```
    set if option constants can also reside in child objects
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AVOption
```
public AVOption()
```
    Default native constructor.
  - AVOption
```
public AVOption(long size)
```
    Native array allocator. Access with Pointer.position(long).
  - AVOption
```
public AVOption(Pointer p)
```
    Pointer cast constructor. Invokes Pointer(Pointer).
- Method Detail
  - position
```
public AVOption position(long position)
```
    Overrides:
    
    position in class Pointer
  - getPointer
```
public AVOption getPointer(long i)
```
    Overrides:
    
    getPointer in class Pointer
  - name
```
@Cast(value="const char*")
public BytePointer name()
```
  - name
```
public AVOption name(BytePointer setter)
```
  - help
```
@Cast(value="const char*")
public BytePointer help()
```
    short English help text \todo What about other languages?
  - help
```
public AVOption help(BytePointer setter)
```
  - offset
```
public int offset()
```
    The offset relative to the context structure where the option value is stored. It should be 0 for named constants.
  - offset
```
public AVOption offset(int setter)
```
  - type
```
@Cast(value="AVOptionType")
public int type()
```
  - type
```
public AVOption type(int setter)
```
  - default_val_i64
```
@Name(value="default_val.i64")
 @Cast(value="int64_t")
public long default_val_i64()
```
    the default value for scalar options
  - default_val_i64
```
public AVOption default_val_i64(long setter)
```
  - default_val_dbl
```
@Name(value="default_val.dbl")
public double default_val_dbl()
```
  - default_val_dbl
```
public AVOption default_val_dbl(double setter)
```
  - default_val_str
```
@Name(value="default_val.str")
 @Cast(value="const char*")
public BytePointer default_val_str()
```
  - default_val_str
```
public AVOption default_val_str(BytePointer setter)
```
  - default_val_q
```
@Name(value="default_val.q")
 @ByRef
public AVRational default_val_q()
```
  - default_val_q
```
public AVOption default_val_q(AVRational setter)
```
  - min
```
public double min()
```
    minimum valid value for the option
  - min
```
public AVOption min(double setter)
```
  - max
```
public double max()
```
    maximum valid value for the option
  - max
```
public AVOption max(double setter)
```
  - flags
```
public int flags()
```
  - flags
```
public AVOption flags(int setter)
```
  - unit
```
@Cast(value="const char*")
public BytePointer unit()
```
    The logical unit to which the option belongs. Non-constant options and corresponding named constants share the same unit. May be NULL.
  - unit
```
public AVOption unit(BytePointer setter)
```

Class AVOption

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.javacpp.Pointer

Methods inherited from class java.lang.Object

Field Detail

AV_OPT_FLAG_ENCODING_PARAM

AV_OPT_FLAG_DECODING_PARAM

AV_OPT_FLAG_AUDIO_PARAM

AV_OPT_FLAG_VIDEO_PARAM

AV_OPT_FLAG_SUBTITLE_PARAM

AV_OPT_FLAG_EXPORT

AV_OPT_FLAG_READONLY

AV_OPT_FLAG_BSF_PARAM

AV_OPT_FLAG_RUNTIME_PARAM

AV_OPT_FLAG_FILTERING_PARAM

AV_OPT_FLAG_DEPRECATED

AV_OPT_FLAG_CHILD_CONSTS

Constructor Detail

AVOption

AVOption

AVOption

Method Detail

position

getPointer

name

name

help

help

offset

offset

type

type

default_val_i64

default_val_i64

default_val_dbl

default_val_dbl

default_val_str

default_val_str

default_val_q

default_val_q

min

min

max

max

flags

flags

unit

unit