prtx::EncodeOptionsValidator Class Reference

#include <EncodeOptionsValidator.h>

Public Member Functions
	EncodeOptionsValidator (const EncodeOptionsValidator &)=delete
	EncodeOptionsValidator (EncodeOptionsValidator &&)=delete
EncodeOptionsValidator &	operator= (const EncodeOptionsValidator &)=delete
EncodeOptionsValidator &	operator= (EncodeOptionsValidator &&)=delete
virtual void	validate (const prtx::PRTUtils::AttributeMapPtr &currValues, const prtx::PRTUtils::AttributeMapBuilderPtr &newValues, const prtx::OptionStatesPtr &states)=0

Detailed Description

Interface for encoder-specific validation of client-generated encoder options.

Member Function Documentation

validate()

virtual void prtx::EncodeOptionsValidator::validate ( const prtx::PRTUtils::AttributeMapPtr &  currValues, const prtx::PRTUtils::AttributeMapBuilderPtr &  newValues, const prtx::OptionStatesPtr &  states  )

pure virtual

Encoder authors may want to implement this interface for each encoder. To use an EncodeOptionsValidator implementation with a specific encoder, register an instance of it with prtx::EncoderInfoBuilder::setValidator() before creating the corresponding EncoderFactory. The validation is triggered by calling prt::EncoderInfo::createValidatedOptionsAndStates().

For example, a simple validate implementation could replace all non-ascii characters of an imaginary encoder option "name" with underscore characters.

See also

prt::EncoderInfo

prtx::OptionStates

Parameters

[in]	currValues	The client-generated option values.
[in,out]	newValues	A builder to receive the validated values.
[out]	states	The validated option states.

---

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

• EncodeOptionsValidator.h