com::avpkit::core::IndexEntry Class Reference

Inheritance diagram for com::avpkit::core::IndexEntry:

Collaboration diagram for com::avpkit::core::IndexEntry:

Public Member Functions
virtual int64_t	getPosition ()
	The position in bytes of the frame corresponding to this index entry in the IContainer. More...
virtual int64_t	getTimeStamp ()
	The actual time stamp, in units of IStream#getTimeBase(), of the frame this entry points to. More...
virtual int32_t	getFlags ()
	Flags set for this entry. More...
virtual int32_t	getSize ()
	The size of bytes of the frame this index entry points to. More...
virtual int32_t	getMinDistance ()
	Minimum number of index entries between this index entry and the last keyframe in the index, used to avoid unneeded searching. More...
virtual bool	isKeyFrame ()
	Is this index entry pointing to a key frame. More...
Public Member Functions inherited from com::avpkit::ferry::RefCounted
virtual int32_t	acquire ()
	Internal Only. More...
virtual int32_t	release ()
	Internal Only. More...
virtual RefCounted *	copyReference ()
	Create a new Java object that refers to the same native object. More...
virtual int32_t	getCurrentRefCount ()
	Return the current reference count on this object. More...
void	setJavaAllocator (void *allocator)
	This method is public but not part of the standard API. More...
void *	getJavaAllocator ()
	This method is public but not part of the standard API. More...

Static Public Member Functions
static IndexEntry *	make (int64_t position, int64_t timeStamp, int32_t flags, int32_t size, int32_t minDistance)
Static Public Member Functions inherited from com::avpkit::core::IIndexEntry
static IIndexEntry *	make (int64_t position, int64_t timeStamp, int32_t flags, int32_t size, int32_t minDistance)
	Create a new IIndexEntry with the specified values. More...

Additional Inherited Members
Static Public Attributes inherited from com::avpkit::core::IIndexEntry
static const int32_t	IINDEX_FLAG_KEYFRAME = 0x0001
	A bit mask value that may be set in getFlags.
Protected Member Functions inherited from com::avpkit::ferry::RefCounted
virtual void	destroy ()
	This method is called by RefCounted objects when their Ref Count reaches zero and they are about to be destroyed.
Protected Attributes inherited from com::avpkit::ferry::RefCounted
AtomicInteger *	mRefCount
	This is the internal reference count, represented as an AtomicInteger to make sure it is thread safe.
void *	mAllocator
	Not part of public API.

Detailed Description

Definition at line 36 of file IndexEntry.h.

Member Function Documentation

getFlags()

int32_t com::avpkit::core::IndexEntry::getFlags ( )

virtual

Flags set for this entry.

See the IINDEX_FLAG* constants above.

Returns

the flags.

Implements com::avpkit::core::IIndexEntry.

Definition at line 60 of file IndexEntry.cpp.

{
  return mEntry.flags;
}

getMinDistance()

int32_t com::avpkit::core::IndexEntry::getMinDistance ( )

virtual

Minimum number of index entries between this index entry and the last keyframe in the index, used to avoid unneeded searching.

Returns

the minimum distance, in bytes.

Implements com::avpkit::core::IIndexEntry.

Definition at line 72 of file IndexEntry.cpp.

{
  return mEntry.min_distance;
}

getPosition()

int64_t com::avpkit::core::IndexEntry::getPosition ( )

virtual

The position in bytes of the frame corresponding to this index entry in the IContainer.

Returns

The byte-offset from start of the IContainer where the frame for this IIndexEntry can be found.

Implements com::avpkit::core::IIndexEntry.

Definition at line 48 of file IndexEntry.cpp.

{
  return mEntry.pos;
}

getSize()

int32_t com::avpkit::core::IndexEntry::getSize ( )

virtual

The size of bytes of the frame this index entry points to.

Returns

The size in bytes.

Implements com::avpkit::core::IIndexEntry.

Definition at line 66 of file IndexEntry.cpp.

{
  return mEntry.size;
}

getTimeStamp()

int64_t com::avpkit::core::IndexEntry::getTimeStamp ( )

virtual

The actual time stamp, in units of IStream#getTimeBase(), of the frame this entry points to.

Returns

The time stamp for this entry.

Implements com::avpkit::core::IIndexEntry.

Definition at line 54 of file IndexEntry.cpp.

{
  return mEntry.timestamp;
}

isKeyFrame()

bool com::avpkit::core::IndexEntry::isKeyFrame ( )

virtual

Is this index entry pointing to a key frame.

Really shorthand for getFlags() & IINDEX_FLAG_KEYFRAME.

Returns

True if this index entry is for a key frame.

Implements com::avpkit::core::IIndexEntry.

Definition at line 78 of file IndexEntry.cpp.

{
  return mEntry.flags & AVINDEX_KEYFRAME;
}

---

The documentation for this class was generated from the following files:

• csrc/com/avpkit/core/IndexEntry.h
• csrc/com/avpkit/core/IndexEntry.cpp