Epok Engine

EPOK RUNTIME

epok::fmv::read_header

Function · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Function

Reads header as part of full-motion video clips and playback statistics.

Belongs to
epok::fmv
Header
fmv_bitstream.hpp
Overloads
1

Declaration

Declaration
inline BsHeader read_header(const uint8_t *frame)

Reads header as part of full-motion video clips and playback statistics.

ParameterTypeMeaning
frameconst uint8_t *Not documented; consult the linked header.

Returns: BsHeader. Consult the linked header for its meaning.

Example sketch

C++ example
#include "fmv_bitstream.hpp"

// Assume these named values have been initialized with valid data:
// const uint8_t * frame

auto result = epok::fmv::read_header(frame);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/fmv_bitstream.hpp:276

Related members