org.bytedeco.ffmpeg.avformat

Class AVIOContext

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.ffmpeg.avformat.AVIOContext

All Implemented Interfaces:

AutoCloseable

@Properties(inherit=avformat.class)
public class AVIOContext
extends Pointer

Bytestream IO Context. New public fields can be added with minor version bumps. Removal, reordering and changes to existing public fields require a major version bump. sizeof(AVIOContext) must not be used outside libav*. \note None of the function pointers in AVIOContext should be called directly, they should only be set by the client application when implementing custom I/O. Normally these are set to the function pointers specified in avio_alloc_context()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AVIOContext.Read_packet_Pointer_BytePointer_int
static class	AVIOContext.Read_pause_Pointer_int Pause or resume playback for network streaming protocols - e.g.
static class	AVIOContext.Read_seek_Pointer_int_long_int Seek to a given timestamp in stream with the specified stream_index.
static class	AVIOContext.Seek_Pointer_long_int
static class	AVIOContext.Update_checksum_long_BytePointer_int
static class	AVIOContext.Write_data_type_Pointer_BytePointer_int_int_long A callback that is used instead of write_packet.
static class	AVIOContext.Write_packet_Pointer_BytePointer_int

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

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AVClass	av_class() A class for private options.
AVIOContext	av_class(AVClass setter)
BytePointer	buf_end() End of the data, may be less than buffer+buffer_size if the read function returned less data than requested, e.g.
AVIOContext	buf_end(BytePointer setter)
BytePointer	buf_ptr_max() Maximum reached position before a backward seek in the write buffer, used keeping track of already written data for a later flush.
AVIOContext	buf_ptr_max(BytePointer setter)
BytePointer	buf_ptr() Current position in the buffer
AVIOContext	buf_ptr(BytePointer setter)
int	buffer_size() Maximum buffer size
AVIOContext	buffer_size(int setter)
BytePointer	buffer() Start of the buffer.
AVIOContext	buffer(BytePointer setter)
long	bytes_read() Read-only statistic of bytes read for this AVIOContext.
AVIOContext	bytes_read(long setter)
long	bytes_written() Read-only statistic of bytes written for this AVIOContext.
AVIOContext	bytes_written(long setter)
BytePointer	checksum_ptr()
AVIOContext	checksum_ptr(BytePointer setter)
long	checksum()
AVIOContext	checksum(long setter)
int	direct() avio_read and avio_write should if possible be satisfied directly instead of going through a buffer, and avio_seek will always call the underlying seek function directly.
AVIOContext	direct(int setter)
int	eof_reached() true if was unable to read due to error or eof
AVIOContext	eof_reached(int setter)
int	error() contains the error code or 0 if no error happened
AVIOContext	error(int setter)
AVIOContext	getPointer(long i)
int	ignore_boundary_point() If set, don't call write_data_type separately for AVIO_DATA_MARKER_BOUNDARY_POINT, but ignore them and treat them as AVIO_DATA_MARKER_UNKNOWN (to avoid needlessly small chunks of data returned from the callback).
AVIOContext	ignore_boundary_point(int setter)
int	max_packet_size()
AVIOContext	max_packet_size(int setter)
int	min_packet_size() Try to buffer at least this amount of data before flushing it.
AVIOContext	min_packet_size(int setter)
Pointer	opaque() A private pointer, passed to the read/write/seek/...
AVIOContext	opaque(Pointer setter)
long	pos() position in the file of the current buffer
AVIOContext	pos(long setter)
AVIOContext	position(long position)
BytePointer	protocol_blacklist() ',' separated list of disallowed protocols.
AVIOContext	protocol_blacklist(BytePointer setter)
BytePointer	protocol_whitelist() ',' separated list of allowed protocols.
AVIOContext	protocol_whitelist(BytePointer setter)
AVIOContext.Read_packet_Pointer_BytePointer_int	read_packet()
AVIOContext	read_packet(AVIOContext.Read_packet_Pointer_BytePointer_int setter)
AVIOContext.Read_pause_Pointer_int	read_pause()
AVIOContext	read_pause(AVIOContext.Read_pause_Pointer_int setter)
AVIOContext.Read_seek_Pointer_int_long_int	read_seek()
AVIOContext	read_seek(AVIOContext.Read_seek_Pointer_int_long_int setter)
AVIOContext.Seek_Pointer_long_int	seek()
AVIOContext	seek(AVIOContext.Seek_Pointer_long_int setter)
int	seekable() A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
AVIOContext	seekable(int setter)
AVIOContext.Update_checksum_long_BytePointer_int	update_checksum()
AVIOContext	update_checksum(AVIOContext.Update_checksum_long_BytePointer_int setter)
AVIOContext.Write_data_type_Pointer_BytePointer_int_int_long	write_data_type()
AVIOContext	write_data_type(AVIOContext.Write_data_type_Pointer_BytePointer_int_int_long setter)
int	write_flag() true if open for writing
AVIOContext	write_flag(int setter)
AVIOContext.Write_packet_Pointer_BytePointer_int	write_packet()
AVIOContext	write_packet(AVIOContext.Write_packet_Pointer_BytePointer_int setter)
long	written() Deprecated. field utilized privately by libavformat. For a public statistic of how many bytes were written out, see AVIOContext::bytes_written.
AVIOContext	written(long 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

Constructor Detail

AVIOContext

public AVIOContext()

Default native constructor.

AVIOContext

public AVIOContext(long size)

Native array allocator. Access with Pointer.position(long).

AVIOContext

public AVIOContext(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public AVIOContext position(long position)

Overrides:

position in class Pointer

getPointer

public AVIOContext getPointer(long i)

Overrides:

getPointer in class Pointer

av_class

@Const
public AVClass av_class()

A class for private options. If this AVIOContext is created by avio_open2(), av_class is set and passes the options down to protocols. If this AVIOContext is manually allocated, then av_class may be set by the caller. warning -- this field can be NULL, be sure to not pass this AVIOContext to any av_opt_* functions in that case.

av_class

public AVIOContext av_class(AVClass setter)

buffer

@Cast(value="unsigned char*")
public BytePointer buffer()

Start of the buffer.

buffer

public AVIOContext buffer(BytePointer setter)

buffer_size

public int buffer_size()

Maximum buffer size

buffer_size

public AVIOContext buffer_size(int setter)

buf_ptr

@Cast(value="unsigned char*")
public BytePointer buf_ptr()

Current position in the buffer

buf_ptr

public AVIOContext buf_ptr(BytePointer setter)

buf_end

@Cast(value="unsigned char*")
public BytePointer buf_end()

End of the data, may be less than buffer+buffer_size if the read function returned less data than requested, e.g. for streams where no more data has been received yet.

buf_end

public AVIOContext buf_end(BytePointer setter)

opaque

public Pointer opaque()

A private pointer, passed to the read/write/seek/... functions.

opaque

public AVIOContext opaque(Pointer setter)

read_packet

public AVIOContext.Read_packet_Pointer_BytePointer_int read_packet()

read_packet

public AVIOContext read_packet(AVIOContext.Read_packet_Pointer_BytePointer_int setter)

write_packet

public AVIOContext.Write_packet_Pointer_BytePointer_int write_packet()

write_packet

public AVIOContext write_packet(AVIOContext.Write_packet_Pointer_BytePointer_int setter)

seek

public AVIOContext.Seek_Pointer_long_int seek()

seek

public AVIOContext seek(AVIOContext.Seek_Pointer_long_int setter)

pos

@Cast(value="int64_t")
public long pos()

position in the file of the current buffer

pos

public AVIOContext pos(long setter)

eof_reached

public int eof_reached()

true if was unable to read due to error or eof

eof_reached

public AVIOContext eof_reached(int setter)

error

public int error()

contains the error code or 0 if no error happened

error

public AVIOContext error(int setter)

write_flag

public int write_flag()

true if open for writing

write_flag

public AVIOContext write_flag(int setter)

max_packet_size

public int max_packet_size()

max_packet_size

public AVIOContext max_packet_size(int setter)

min_packet_size

public int min_packet_size()

Try to buffer at least this amount of data before flushing it.

min_packet_size

public AVIOContext min_packet_size(int setter)

checksum

@Cast(value="unsigned long")
public long checksum()

checksum

public AVIOContext checksum(long setter)

checksum_ptr

@Cast(value="unsigned char*")
public BytePointer checksum_ptr()

checksum_ptr

public AVIOContext checksum_ptr(BytePointer setter)

update_checksum

public AVIOContext.Update_checksum_long_BytePointer_int update_checksum()

update_checksum

public AVIOContext update_checksum(AVIOContext.Update_checksum_long_BytePointer_int setter)

read_pause

public AVIOContext.Read_pause_Pointer_int read_pause()

read_pause

public AVIOContext read_pause(AVIOContext.Read_pause_Pointer_int setter)

read_seek

public AVIOContext.Read_seek_Pointer_int_long_int read_seek()

read_seek

public AVIOContext read_seek(AVIOContext.Read_seek_Pointer_int_long_int setter)

seekable

public int seekable()

A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.

seekable

public AVIOContext seekable(int setter)

direct

public int direct()

avio_read and avio_write should if possible be satisfied directly instead of going through a buffer, and avio_seek will always call the underlying seek function directly.

direct

public AVIOContext direct(int setter)

protocol_whitelist

@Cast(value="const char*")
public BytePointer protocol_whitelist()

',' separated list of allowed protocols.

protocol_whitelist

public AVIOContext protocol_whitelist(BytePointer setter)

protocol_blacklist

@Cast(value="const char*")
public BytePointer protocol_blacklist()

',' separated list of disallowed protocols.

protocol_blacklist

public AVIOContext protocol_blacklist(BytePointer setter)

write_data_type

public AVIOContext.Write_data_type_Pointer_BytePointer_int_int_long write_data_type()

write_data_type

public AVIOContext write_data_type(AVIOContext.Write_data_type_Pointer_BytePointer_int_int_long setter)

ignore_boundary_point

public int ignore_boundary_point()

If set, don't call write_data_type separately for AVIO_DATA_MARKER_BOUNDARY_POINT, but ignore them and treat them as AVIO_DATA_MARKER_UNKNOWN (to avoid needlessly small chunks of data returned from the callback).

ignore_boundary_point

public AVIOContext ignore_boundary_point(int setter)

written

@Cast(value="int64_t")
 @Deprecated
public long written()

Deprecated. field utilized privately by libavformat. For a public statistic of how many bytes were written out, see AVIOContext::bytes_written.

written

public AVIOContext written(long setter)

buf_ptr_max

@Cast(value="unsigned char*")
public BytePointer buf_ptr_max()

Maximum reached position before a backward seek in the write buffer, used keeping track of already written data for a later flush.

buf_ptr_max

public AVIOContext buf_ptr_max(BytePointer setter)

bytes_read

@Cast(value="int64_t")
public long bytes_read()

Read-only statistic of bytes read for this AVIOContext.

bytes_read

public AVIOContext bytes_read(long setter)

bytes_written

@Cast(value="int64_t")
public long bytes_written()

Read-only statistic of bytes written for this AVIOContext.

bytes_written

public AVIOContext bytes_written(long setter)