DirectShowSettings Class Reference

Settings for initializing a direct show engine recorder. More...

#include <cvb/movie2/recording_settings.hpp>

Inherits RecordingSettings.

Public Member Functions
std::vector< String >	AvailableCodecs ()
	Gets the available codecs currently installed in the system.
String	Codec () const
	Gets the name of the codec to use.
void	SetCodec (const String &name)
	Sets the name of the codec to use.
bool	UseMetaData () const noexcept
	Gets whether text metadata is to be written into the stream.
void	SetUseMetaData (bool useMetaData) noexcept
	Sets whether text metadata is to be written into the stream.
Public Member Functions inherited from RecordingSettings
double	FrameRate () const noexcept
	Gets the frame rate the video uses for playback.
void	SetFrameRate (double frameRate)
	Sets the frame rate the video uses for playback.
RecordingEngineType	EngineType () const noexcept
	Returns the engine type.

Detailed Description

Settings for initializing a direct show engine recorder.

Member Function Documentation

AvailableCodecs()

std::vector< String > AvailableCodecs ( )

inline

Gets the available codecs currently installed in the system.

Returns

List containing the names of the codecs.

Exceptions

Any	exception derived from std::exception including CvbException.

Codec()

String Codec ( ) const

inline

Gets the name of the codec to use.

Returns

The codec name.

Exceptions

Any	exception derived from std::exception including CvbException.

SetCodec()

void SetCodec ( const String & name )

inline

Sets the name of the codec to use.

Parameters

[in]

name

The new codec name.

Exceptions

Any	exception derived from std::exception including CvbException.

SetUseMetaData()

void SetUseMetaData ( bool useMetaData )

inlinenoexcept

Sets whether text metadata is to be written into the stream.

Parameters

[in]

useMetaData

True to write metadata, false otherwise.

Exceptions

Does	not throw any exception.

Default is false as some players reject video streams containing text metadata.

UseMetaData()

bool UseMetaData ( ) const

inlinenoexcept

Gets whether text metadata is to be written into the stream.

Returns

True if metadata is written, false otherwise.

Exceptions

Does	not throw any exception.

Default is false as some players reject video streams containing text metadata.