NIST Biometric Evaluation Framework
Software components for biometric technology evaluations
Public Member Functions | List of all members
BiometricEvaluation::Video::Container Class Reference

Representation of a video container. More...

#include <be_video_container.h>

Public Member Functions

 Container (const Memory::uint8Array &buffer)
 Construct a Container from a memory buffer. More...
 
 Container (const std::shared_ptr< Memory::uint8Array > &buffer)
 Construct a Container from a memory buffer wrapped in a shared pointer. More...
 
 Container (const std::string &filename)
 Construct a Container from file. More...
 
uint32_t getAudioCount ()
 Obtain the number of audio streams. More...
 
uint32_t getVideoCount ()
 Obtain the number of video streams. More...
 
std::unique_ptr< Video::StreamgetVideoStream (uint32_t videoNum)
 Obtain a video stream from the container. More...
 
 ~Container ()
 

Detailed Description

Representation of a video container.

The Container class represents a single container stream that can be used to access the video and audio components of the stream.

Definition at line 29 of file be_video_container.h.

Constructor & Destructor Documentation

◆ Container() [1/3]

BiometricEvaluation::Video::Container::Container ( const Memory::uint8Array buffer)

Construct a Container from a memory buffer.

Using this constructor can result in buffer memory usage twice that of other constructors.

Exceptions
Error::MemoryErrorError allocating memory for internal buffering.
Error::StrategyErrorOther error when reading the container stream.

◆ Container() [2/3]

BiometricEvaluation::Video::Container::Container ( const std::shared_ptr< Memory::uint8Array > &  buffer)

Construct a Container from a memory buffer wrapped in a shared pointer.

Applications must not modify the data underlying the AutoArray.

Exceptions
Error::MemoryErrorError allocating memory for internal buffering.
Error::StrategyErrorOther error when reading the container stream.

◆ Container() [3/3]

BiometricEvaluation::Video::Container::Container ( const std::string &  filename)

Construct a Container from file.

Exceptions
Error::ObjectDoesNotExistFile does not exist.
Error::MemoryErrorError allocating memory for internal buffering.
Error::StrategyErrorOther error when reading the container stream.

◆ ~Container()

BiometricEvaluation::Video::Container::~Container ( )

Member Function Documentation

◆ getAudioCount()

uint32_t BiometricEvaluation::Video::Container::getAudioCount ( )

Obtain the number of audio streams.

◆ getVideoCount()

uint32_t BiometricEvaluation::Video::Container::getVideoCount ( )

Obtain the number of video streams.

◆ getVideoStream()

std::unique_ptr< Video::Stream > BiometricEvaluation::Video::Container::getVideoStream ( uint32_t  videoNum)

Obtain a video stream from the container.

Video streams are indexed independently from other streams in the container.

Parameters
videoNumThe number of the video stream within the container.
Exceptions
Error::ParameterErrorThe requested video stream is not available.

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