AviHeader class

AviHeader class

Represents the AVIMAINHEADER structure in an AVI video.

Inheritance: AviHeader → CustomPackage → MetadataPackage

The AviHeader type exposes the following members:

Constructors

Constructor Description
__init__(self) Initializes a new instance of the AviHeader class.

Properties

Property Description
metadata_type Gets the metadata type.
keys Gets a collection of the metadata property names.
property_descriptors Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
count Gets the number of metadata properties.
micro_sec_per_frame Gets the the number of microseconds between frames. This value indicates the overall timing for the file.
max_bytes_per_sec Gets the approximate maximum data rate of the file.


This value indicates the number of bytes per second the system must handle to present an AVI sequence as
specified by the other parameters contained in the main header and stream header chunks.
padding_granularity Gets the alignment for data, in bytes. Pad the data to multiples of this value.
avi_header_flags Gets a bitwise combination of zero or more of the AVI flags.
total_frames Gets the the total number of frames of data in the file.
initial_frames Gets the initial frame for interleaved files.


Noninterleaved files should specify zero. If you are creating interleaved files, specify the number of frames
in the file prior to the initial frame of the AVI sequence in this member.
streams Gets the number of streams in the file. For example, a file with audio and video has two streams.
suggested_buffer_size Gets the suggested buffer size for reading the file.


Generally, this size should be large enough to contain the largest chunk in the file.
If set to zero, or if it is too small, the playback software will have to reallocate memory during playback, which will reduce performance. For an interleaved file,
the buffer size should be large enough to read an entire record, and not just a chunk.
width Gets the width of the AVI file in pixels.
height Gets the height of the AVI file in pixels.

Methods

Method Description
contains(self, property_name) Determines whether the package contains a metadata property with the specified name.
find_properties(self, specification) Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.
update_properties(self, specification, value) Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.
remove_properties(self, specification) Removes metadata properties satisfying a specification.
add_properties(self, specification, value) Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
set_properties(self, specification, value) Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of MetadataPackage.add_properties and MetadataPackage.update_properties.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.
sanitize(self) Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

Remarks

Learn more | | |

See Also

AsfVideoStreamProperty class AviRootPackage class