Contains the configuration data for a VMXResource whose VMXResourceType is Encoder. More...

Inheritance diagram for EncoderConfig:

Public Types
enum	EncoderEdge { x1, x2, x4 }
	Specifies whether the encoder counter is invoked on every edge, every other edge, or every fourth edge.

Public Member Functions
	EncoderConfig ()
	EncoderConfig default constructor; sets all values to defaults.

	EncoderConfig (EncoderEdge edge)
	EncoderConfig constructor; initializes values with the provided input parameters *. More...

EncoderEdge	GetEncoderEdge ()
	Returns the configured EncoderEdge.

void	SetEncoderEdge (EncoderEdge edge)
	Sets the configured EncoderEdge.

virtual VMXResourceConfig *	GetCopy () const
	Instantiates a copy of the configuration data. More...

virtual bool	Copy (const VMXResourceConfig *p_config)
	Copies the contents of the source VMXResourceConfig object into this object. More...

Public Member Functions inherited from VMXResourceConfig
	VMXResourceConfig (VMXResourceType res_type)

VMXResourceType	GetResourceType () const
	VMXResourceType which this configuration applies to.

Public Attributes
EncoderEdge	edge_count

Public Attributes inherited from VMXResourceConfig
VMXResourceType	res_type

Detailed Description

Contains the configuration data for a VMXResource whose VMXResourceType is Encoder.

Constructor & Destructor Documentation

EncoderConfig::EncoderConfig ( EncoderEdge edge )

inline

EncoderConfig constructor; initializes values with the provided input parameters *.

Parameters

edge	The EncoderEdge configuration to be used

virtual bool EncoderConfig::Copy ( const VMXResourceConfig * p_config )

inlinevirtual

Copies the contents of the source VMXResourceConfig object into this object.

NOTE: The source object's VMXResourceType must match this object's VMXResourceType.

Parameters

[in] p_config The source VMXResourceConfig object from which to copy configuration data into this object.

virtual VMXResourceConfig* EncoderConfig::GetCopy ( ) const

inlinevirtual

Instantiates a copy of the configuration data.

NOTE: The caller is responsible to delete the object returned from this method.

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