AVStream (JavaCPP Presets for FFmpeg 4.4-1.5.6 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.ffmpeg.avformat.AVStream

All Implemented Interfaces:

AutoCloseable
```
@Properties(inherit=avformat.class)
public class AVStream
extends Pointer
```
Stream structure. New fields can be added to the end with minor version bumps. Removal, reordering and changes to existing fields require a major version bump. sizeof(AVStream) must not be used outside libav*.

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`	`AVSTREAM_EVENT_FLAG_METADATA_UPDATED` - demuxing: the demuxer read new metadata from the file and updated AVStream.metadata accordingly - muxing: the user updated AVStream.metadata and wishes the muxer to write it into the file
`static int`	`AVSTREAM_EVENT_FLAG_NEW_PACKETS` - demuxing: new packets for this stream were read from the file.

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

Constructor Summary

Constructors
Constructor and Description

AVStream()
Default native constructor.

AVStream(long size)
Native array allocator.

AVStream(Pointer p)
Pointer cast constructor.

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AVPacket`	`attached_pic()` For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet will contain the attached picture.
`AVStream`	`attached_pic(AVPacket setter)`
`AVRational`	`avg_frame_rate()` Average framerate - demuxing: May be set by libavformat when creating the stream or in avformat_find_stream_info().
`AVStream`	`avg_frame_rate(AVRational setter)`
`int`	`codec_info_nb_frames()` Number of frames that have been demuxed during avformat_find_stream_info()
`AVStream`	`codec_info_nb_frames(int setter)`
`AVCodecContext`	`codec()` Deprecated. use the codecpar struct instead
`AVStream`	`codec(AVCodecContext setter)`
`AVCodecParameters`	`codecpar()` Codec parameters associated with this stream.
`AVStream`	`codecpar(AVCodecParameters setter)`
`long`	`cur_dts()`
`AVStream`	`cur_dts(long setter)`
`int`	`discard()` Selects which packets can be discarded at will and do not need to be demuxed.
`AVStream`	`discard(int setter)`
`int`	`disposition()` AV_DISPOSITION_* bit field
`AVStream`	`disposition(int setter)`
`long`	`duration()` Decoding: duration of the stream, in stream time base.
`AVStream`	`duration(long setter)`
`int`	`event_flags()` Flags indicating events happening on the stream, a combination of AVSTREAM_EVENT_FLAG_*.
`AVStream`	`event_flags(int setter)`
`long`	`first_dts()` Timestamp corresponding to the last dts sync point.
`AVStream`	`first_dts(long setter)`
`AVStream`	`getPointer(long i)`
`int`	`id()` Format-specific stream ID.
`AVStream`	`id(int setter)`
`int`	`index_entries_allocated_size()`
`AVStream`	`index_entries_allocated_size(int setter)`
`AVIndexEntry`	`index_entries()` Only used if the format does not support seeking natively.
`AVStream`	`index_entries(AVIndexEntry setter)`
`int`	`index()` stream index in AVFormatContext
`AVStream`	`index(int setter)`
`AVStreamInternal`	`internal()` An opaque field for libavformat internal usage.
`AVStream`	`internal(AVStreamInternal setter)`
`int`	`last_IP_duration()`
`AVStream`	`last_IP_duration(int setter)`
`long`	`last_IP_pts()`
`AVStream`	`last_IP_pts(long setter)`
`AVDictionary`	`metadata()`
`AVStream`	`metadata(AVDictionary setter)`
`long`	`nb_frames()` number of frames in this stream if known or 0
`AVStream`	`nb_frames(long setter)`
`int`	`nb_index_entries()`
`AVStream`	`nb_index_entries(int setter)`
`int`	`nb_side_data()` The number of elements in the AVStream.side_data array.
`AVStream`	`nb_side_data(int setter)`
`int`	`need_parsing()`
`AVStream`	`need_parsing(int setter)`
`AVCodecParserContext`	`parser()`
`AVStream`	`parser(AVCodecParserContext setter)`
`AVStream`	`position(long position)`
`Pointer`	`priv_data()`
`AVStream`	`priv_data(Pointer setter)`
`int`	`probe_packets()` Number of packets to buffer for codec probing
`AVStream`	`probe_packets(int setter)`
`int`	`pts_wrap_bits()` number of bits in pts (used for wrapping control)
`AVStream`	`pts_wrap_bits(int setter)`
`AVRational`	`r_frame_rate()` Real base framerate of the stream.
`AVStream`	`r_frame_rate(AVRational setter)`
`BytePointer`	`recommended_encoder_configuration()` Deprecated. unused
`AVStream`	`recommended_encoder_configuration(BytePointer setter)`
`AVRational`	`sample_aspect_ratio()` sample aspect ratio (0 if unknown) - encoding: Set by user.
`AVStream`	`sample_aspect_ratio(AVRational setter)`
`AVPacketSideData`	`side_data()` An array of side data that applies to the whole stream (i.e.
`AVStream`	`side_data(AVPacketSideData setter)`
`long`	`start_time()` Decoding: pts of the first frame of the stream in presentation order, in stream time base.
`AVStream`	`start_time(long setter)`
`int`	`stream_identifier()` Stream Identifier This is the MPEG-TS stream identifier +1 0 means unknown
`AVStream`	`stream_identifier(int setter)`
`AVRational`	`time_base()` This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
`AVStream`	`time_base(AVRational setter)`
`Pointer`	`unused()` All fields below this line are not part of the public API.
`AVStream`	`unused(Pointer setter)`
`int`	`unused10()`
`AVStream`	`unused10(int setter)`
`LongPointer`	`unused5()`
`long`	`unused5(int i)`
`AVStream`	`unused5(int i, long setter)`
`AVProbeData`	`unused6()`
`AVStream`	`unused6(AVProbeData setter)`
`Pointer`	`unused7()`
`AVStream`	`unused7(Pointer setter)`
`int`	`unused8()`
`AVStream`	`unused8(int setter)`
`int`	`unused9()`
`AVStream`	`unused9(int 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, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, 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
  - AVSTREAM_EVENT_FLAG_METADATA_UPDATED
```
public static final int AVSTREAM_EVENT_FLAG_METADATA_UPDATED
```
    - demuxing: the demuxer read new metadata from the file and updated AVStream.metadata accordingly - muxing: the user updated AVStream.metadata and wishes the muxer to write it into the file
    
    See Also:
    
    Constant Field Values
  - AVSTREAM_EVENT_FLAG_NEW_PACKETS
```
public static final int AVSTREAM_EVENT_FLAG_NEW_PACKETS
```
    - demuxing: new packets for this stream were read from the file. This event is informational only and does not guarantee that new packets for this stream will necessarily be returned from av_read_frame().
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AVStream
```
public AVStream()
```
    Default native constructor.
  - AVStream
```
public AVStream(long size)
```
    Native array allocator. Access with Pointer.position(long).
  - AVStream
```
public AVStream(Pointer p)
```
    Pointer cast constructor. Invokes Pointer(Pointer).
- Method Detail
  - position
```
public AVStream position(long position)
```
    Overrides:
    
    position in class Pointer
  - getPointer
```
public AVStream getPointer(long i)
```
    Overrides:
    
    getPointer in class Pointer
  - index
```
public int index()
```
    stream index in AVFormatContext
  - index
```
public AVStream index(int setter)
```
  - id
```
public int id()
```
    Format-specific stream ID. decoding: set by libavformat encoding: set by the user, replaced by libavformat if left unset
  - id
```
public AVStream id(int setter)
```
  - codec
```
@Deprecated
public AVCodecContext codec()
```
    Deprecated. use the codecpar struct instead
  - codec
```
public AVStream codec(AVCodecContext setter)
```
  - priv_data
```
public Pointer priv_data()
```
  - priv_data
```
public AVStream priv_data(Pointer setter)
```
  - time_base
```
@ByRef
public AVRational time_base()
```
    This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented. decoding: set by libavformat encoding: May be set by the caller before avformat_write_header() to provide a hint to the muxer about the desired timebase. In avformat_write_header(), the muxer will overwrite this field with the timebase that will actually be used for the timestamps written into the file (which may or may not be related to the user-provided one, depending on the format).
  - time_base
```
public AVStream time_base(AVRational setter)
```
  - start_time
```
@Cast(value="int64_t")
public long start_time()
```
    Decoding: pts of the first frame of the stream in presentation order, in stream time base. Only set this if you are absolutely 100% sure that the value you set it to really is the pts of the first frame. This may be undefined (AV_NOPTS_VALUE). \note The ASF header does NOT contain a correct start_time the ASF demuxer must NOT set this.
  - start_time
```
public AVStream start_time(long setter)
```
  - duration
```
@Cast(value="int64_t")
public long duration()
```
    Decoding: duration of the stream, in stream time base. If a source file does not specify a duration, but does specify a bitrate, this value will be estimated from bitrate and file size. Encoding: May be set by the caller before avformat_write_header() to provide a hint to the muxer about the estimated duration.
  - duration
```
public AVStream duration(long setter)
```
  - nb_frames
```
@Cast(value="int64_t")
public long nb_frames()
```
    number of frames in this stream if known or 0
  - nb_frames
```
public AVStream nb_frames(long setter)
```
  - disposition
```
public int disposition()
```
    AV_DISPOSITION_* bit field
  - disposition
```
public AVStream disposition(int setter)
```
  - discard
```
@Cast(value="AVDiscard")
public int discard()
```
    Selects which packets can be discarded at will and do not need to be demuxed.
  - discard
```
public AVStream discard(int setter)
```
  - sample_aspect_ratio
```
@ByRef
public AVRational sample_aspect_ratio()
```
    sample aspect ratio (0 if unknown) - encoding: Set by user. - decoding: Set by libavformat.
  - sample_aspect_ratio
```
public AVStream sample_aspect_ratio(AVRational setter)
```
  - metadata
```
public AVDictionary metadata()
```
  - metadata
```
public AVStream metadata(AVDictionary setter)
```
  - avg_frame_rate
```
@ByRef
public AVRational avg_frame_rate()
```
    Average framerate - demuxing: May be set by libavformat when creating the stream or in avformat_find_stream_info(). - muxing: May be set by the caller before avformat_write_header().
  - avg_frame_rate
```
public AVStream avg_frame_rate(AVRational setter)
```
  - attached_pic
```
@ByRef
public AVPacket attached_pic()
```
    For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet will contain the attached picture. decoding: set by libavformat, must not be modified by the caller. encoding: unused
  - attached_pic
```
public AVStream attached_pic(AVPacket setter)
```
  - side_data
```
public AVPacketSideData side_data()
```
    An array of side data that applies to the whole stream (i.e. the container does not allow it to change between packets). There may be no overlap between the side data in this array and side data in the packets. I.e. a given side data is either exported by the muxer (demuxing) / set by the caller (muxing) in this array, then it never appears in the packets, or the side data is exported / sent through the packets (always in the first packet where the value becomes known or changes), then it does not appear in this array. - demuxing: Set by libavformat when the stream is created. - muxing: May be set by the caller before avformat_write_header(). Freed by libavformat in avformat_free_context().
    
    See Also:
    
    av_format_inject_global_side_data()
  - side_data
```
public AVStream side_data(AVPacketSideData setter)
```
  - nb_side_data
```
public int nb_side_data()
```
    The number of elements in the AVStream.side_data array.
  - nb_side_data
```
public AVStream nb_side_data(int setter)
```
  - event_flags
```
public int event_flags()
```
    Flags indicating events happening on the stream, a combination of AVSTREAM_EVENT_FLAG_*. - demuxing: may be set by the demuxer in avformat_open_input(), avformat_find_stream_info() and av_read_frame(). Flags must be cleared by the user once the event has been handled. - muxing: may be set by the user after avformat_write_header(). to indicate a user-triggered event. The muxer will clear the flags for events it has handled in av_[interleaved]_write_frame().
  - event_flags
```
public AVStream event_flags(int setter)
```
  - r_frame_rate
```
@ByRef
public AVRational r_frame_rate()
```
    Real base framerate of the stream. This is the lowest framerate with which all timestamps can be represented accurately (it is the least common multiple of all framerates in the stream). Note, this value is just a guess! For example, if the time base is 1/90000 and all frames have either approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
  - r_frame_rate
```
public AVStream r_frame_rate(AVRational setter)
```
  - recommended_encoder_configuration
```
@Cast(value="char*")
 @Deprecated
public BytePointer recommended_encoder_configuration()
```
    Deprecated. unused
    
    String containing pairs of key and values describing recommended encoder configuration. Pairs are separated by ','. Keys are separated from values by '='.
  - recommended_encoder_configuration
```
public AVStream recommended_encoder_configuration(BytePointer setter)
```
  - codecpar
```
public AVCodecParameters codecpar()
```
    Codec parameters associated with this stream. Allocated and freed by libavformat in avformat_new_stream() and avformat_free_context() respectively. - demuxing: filled by libavformat on stream creation or in avformat_find_stream_info() - muxing: filled by the caller before avformat_write_header()
  - codecpar
```
public AVStream codecpar(AVCodecParameters setter)
```
  - unused
```
public Pointer unused()
```
    All fields below this line are not part of the public API. They may not be used outside of libavformat and can be changed and removed at will. Internal note: be aware that physically removing these fields will break ABI. Replace removed fields with dummy fields, and add new fields to AVStreamInternal.
  - unused
```
public AVStream unused(Pointer setter)
```
  - pts_wrap_bits
```
public int pts_wrap_bits()
```
    number of bits in pts (used for wrapping control)
  - pts_wrap_bits
```
public AVStream pts_wrap_bits(int setter)
```
  - first_dts
```
@Cast(value="int64_t")
public long first_dts()
```
    Timestamp corresponding to the last dts sync point. Initialized when AVCodecParserContext.dts_sync_point >= 0 and a DTS is received from the underlying container. Otherwise set to AV_NOPTS_VALUE by default.
  - first_dts
```
public AVStream first_dts(long setter)
```
  - cur_dts
```
@Cast(value="int64_t")
public long cur_dts()
```
  - cur_dts
```
public AVStream cur_dts(long setter)
```
  - last_IP_pts
```
@Cast(value="int64_t")
public long last_IP_pts()
```
  - last_IP_pts
```
public AVStream last_IP_pts(long setter)
```
  - last_IP_duration
```
public int last_IP_duration()
```
  - last_IP_duration
```
public AVStream last_IP_duration(int setter)
```
  - probe_packets
```
public int probe_packets()
```
    Number of packets to buffer for codec probing
  - probe_packets
```
public AVStream probe_packets(int setter)
```
  - codec_info_nb_frames
```
public int codec_info_nb_frames()
```
    Number of frames that have been demuxed during avformat_find_stream_info()
  - codec_info_nb_frames
```
public AVStream codec_info_nb_frames(int setter)
```
  - need_parsing
```
@Cast(value="AVStreamParseType")
public int need_parsing()
```
  - need_parsing
```
public AVStream need_parsing(int setter)
```
  - parser
```
public AVCodecParserContext parser()
```
  - parser
```
public AVStream parser(AVCodecParserContext setter)
```
  - unused7
```
public Pointer unused7()
```
  - unused7
```
public AVStream unused7(Pointer setter)
```
  - unused6
```
@ByRef
public AVProbeData unused6()
```
  - unused6
```
public AVStream unused6(AVProbeData setter)
```
  - unused5
```
@Cast(value="int64_t")
public long unused5(int i)
```
  - unused5
```
public AVStream unused5(int i,
                        long setter)
```
  - unused5
```
@MemberGetter
 @Cast(value="int64_t*")
public LongPointer unused5()
```
  - index_entries
```
public AVIndexEntry index_entries()
```
    Only used if the format does not support seeking natively.
  - index_entries
```
public AVStream index_entries(AVIndexEntry setter)
```
  - nb_index_entries
```
public int nb_index_entries()
```
  - nb_index_entries
```
public AVStream nb_index_entries(int setter)
```
  - index_entries_allocated_size
```
@Cast(value="unsigned int")
public int index_entries_allocated_size()
```
  - index_entries_allocated_size
```
public AVStream index_entries_allocated_size(int setter)
```
  - stream_identifier
```
public int stream_identifier()
```
    Stream Identifier This is the MPEG-TS stream identifier +1 0 means unknown
  - stream_identifier
```
public AVStream stream_identifier(int setter)
```
  - unused8
```
public int unused8()
```
  - unused8
```
public AVStream unused8(int setter)
```
  - unused9
```
public int unused9()
```
  - unused9
```
public AVStream unused9(int setter)
```
  - unused10
```
public int unused10()
```
  - unused10
```
public AVStream unused10(int setter)
```
  - internal
```
public AVStreamInternal internal()
```
    An opaque field for libavformat internal usage. Must not be accessed in any way by callers.
  - internal
```
public AVStream internal(AVStreamInternal setter)
```

Class AVStream

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

AVSTREAM_EVENT_FLAG_METADATA_UPDATED

AVSTREAM_EVENT_FLAG_NEW_PACKETS

Constructor Detail

AVStream

AVStream

AVStream

Method Detail

position

getPointer

index

index

id

id

codec

codec

priv_data

priv_data

time_base

time_base

start_time

start_time

duration

duration

nb_frames

nb_frames

disposition

disposition

discard

discard

sample_aspect_ratio

sample_aspect_ratio

metadata

metadata

avg_frame_rate

avg_frame_rate

attached_pic

attached_pic

side_data

side_data

nb_side_data

nb_side_data

event_flags

event_flags

r_frame_rate

r_frame_rate

recommended_encoder_configuration

recommended_encoder_configuration

codecpar

codecpar

unused

unused

pts_wrap_bits

pts_wrap_bits

first_dts

first_dts

cur_dts

cur_dts

last_IP_pts

last_IP_pts

last_IP_duration

last_IP_duration

probe_packets

probe_packets

codec_info_nb_frames

codec_info_nb_frames

need_parsing

need_parsing

parser

parser

unused7