WrappingOption Class Reference

#include <essence.h>

Inheritance diagram for WrappingOption:

RefCount IRefCount List of all members.

Public Types

enum  WrapType {
  None, Frame, Clip, Line,
  Other
}
 Wrapping type. More...

Public Attributes

EssenceSubParserParent Handler
 Pointer to the object that can parse this wrapping option - parent pointer because the parser holds a copy of this!
std::string Name
 A short name, unique for this sub-parser, for this wrapping option (or "" if not supported by this handler).
std::string Description
 Human readable description of this wrapping option (to allow user selection).
ULPtr WrappingID
 A UL (or endian swapped UUID) that uniquely identifies this sub-parser/wrapping option combination (or NULL if not suppoered by this handler).
ULPtr WrappingUL
 UL for this wrapping.
ULList RequiredPartners
 List of other items that *MUST* accompany this item to use this wrapping.
UInt8 GCEssenceType
 The Generic Container essence type, or 0 if not a GC wrapping.
UInt8 GCElementType
 The Generic Container element value, or 0 if not a GC wrapping.
WrapType ThisWrapType
 The type of this wrapping (frame, clip etc.).
bool CanSlave
 True if this wrapping can be a "slave" which allows it to be used at a different edit rate than its own.
bool CanIndex
 True if this wrapping can be VBR indexed by the handler (CBR essence may need VBR indexing when interleaved).
bool CBRIndex
 True if this wrapping will use a CBR index table (and therefore has a non-zero return value from GetBytesPerEditUnit() ).
UInt8 BERSize
 The BER length size to use for this wrapping (or 0 for any).
UInt32 BytesPerEditUnit
 set non zero for ConstSamples

Member Enumeration Documentation

enum WrapType

Wrapping type.

Note:
"None" is only for use as a default condition
Enumerator:
None 
Frame 
Clip 
Line 
Other 


Member Data Documentation

EssenceSubParserParent Handler

Pointer to the object that can parse this wrapping option - parent pointer because the parser holds a copy of this!

std::string Name

A short name, unique for this sub-parser, for this wrapping option (or "" if not supported by this handler).

std::string Description

Human readable description of this wrapping option (to allow user selection).

ULPtr WrappingID

A UL (or endian swapped UUID) that uniquely identifies this sub-parser/wrapping option combination (or NULL if not suppoered by this handler).

This allows an application to specify a desired wrapping, or list of wrappings, for automated selection

ULPtr WrappingUL

UL for this wrapping.

ULList RequiredPartners

List of other items that *MUST* accompany this item to use this wrapping.

UInt8 GCEssenceType

The Generic Container essence type, or 0 if not a GC wrapping.

UInt8 GCElementType

The Generic Container element value, or 0 if not a GC wrapping.

WrapType ThisWrapType

The type of this wrapping (frame, clip etc.).

bool CanSlave

True if this wrapping can be a "slave" which allows it to be used at a different edit rate than its own.

bool CanIndex

True if this wrapping can be VBR indexed by the handler (CBR essence may need VBR indexing when interleaved).

bool CBRIndex

True if this wrapping will use a CBR index table (and therefore has a non-zero return value from GetBytesPerEditUnit() ).

UInt8 BERSize

The BER length size to use for this wrapping (or 0 for any).

UInt32 BytesPerEditUnit

set non zero for ConstSamples


The documentation for this class was generated from the following file:
Generated on Mon Apr 2 15:20:58 2007 for MXFLib by  doxygen 1.5.1-p1