IndexPos Class Reference

Structure for holding the result of an index table look-up. More...

#include <index.h>

Inheritance diagram for IndexPos:

List of all members.

Public Attributes
UInt64	ThisPos
	The position (in file package edit units) of the data of which Location indexes the start.
Position	Location
	The location of the start of ThisPos edit unit in the essence container.
Rational	PosOffset
	The temporal offset for this edit unit (if Offset = true, otherwise undefined).
bool	Exact
	true if ThisPos is the requested edit unit and the location is for the requested sub-item.
bool	OtherPos
	true if ThisPos is not the requested edit unit
bool	Offset
	true if there is a temporal offset (stored in PosOffset, only set if Exact = true)
Int8	KeyFrameOffset
	The offset in edit units to the previous key frame.
Int64	KeyLocation
	The location of the start of the keyframe edit unit in the essence container.
UInt8	Flags
	The flags for this edit unit (zero if ThisPos is not the requested edit unit).

---

Detailed Description

Structure for holding the result of an index table look-up.

---

Member Data Documentation

UInt64 ThisPos

The position (in file package edit units) of the data of which Location indexes the start.

Note:

If Exact = false and OtherPos = true this will be the un-reordered or bytestream position of a different edit unit of data whose location is returned in Location. This happens if the exact location is not indexed for some reason such as a sparse or incomplete index table. The location returned will be a "hint" of where to start looking for the un-indexed data.

Position Location

The location of the start of ThisPos edit unit in the essence container.

Rational PosOffset

The temporal offset for this edit unit (if Offset = true, otherwise undefined).

bool Exact

true if ThisPos is the requested edit unit and the location is for the requested sub-item.

false if it is a preceeding edit unit or the requested sub-item could not be identified

bool OtherPos

true if ThisPos is not the requested edit unit

Note:

This should be tested if "Exact" is false as the value of "ThisPos" will be the non-reordered position and may equal the requested location even though Location does not index the requested edit unit

bool Offset

true if there is a temporal offset (stored in PosOffset, only set if Exact = true)

Int8 KeyFrameOffset

The offset in edit units to the previous key frame.

Int64 KeyLocation

The location of the start of the keyframe edit unit in the essence container.

UInt8 Flags

The flags for this edit unit (zero if ThisPos is not the requested edit unit).

---

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

• index.h

---