Public Member Functions | Static Public Member Functions | Private Attributes
vidl_dshow_istream_params Class Reference

Parameter structure for DirectShow input streams. More...

#include <vidl_dshow_istream_params.h>

List of all members.

Public Member Functions

 vidl_dshow_istream_params ()
 Constructor - default.
void configure_filter (const CComPtr< IBaseFilter > &source)
 Configure the source filter based on the parameters.
vidl_dshow_istream_params & set_properties (const vcl_map< vcl_string, vcl_string > &props)
 Set properties from a map(string,value).
bool register_in_rot () const
bool run_when_ready () const
vcl_string save_graph_to () const
vcl_string device_name () const
vcl_string output_filename () const
GUID target_output_format () const
vidl_dshow_istream_params & set_register_in_rot (bool)
vidl_dshow_istream_params & set_run_when_ready (bool)
vidl_dshow_istream_params & set_save_graph_to (const vcl_string &)
vidl_dshow_istream_params & set_device_name (const vcl_string &)
vidl_dshow_istream_params & set_output_filename (const vcl_string &)
vidl_dshow_istream_params & set_target_output_format (GUID)
vidl_dshow_istream_params & set_load_filter_defaults (bool)
vidl_dshow_istream_params & set_output_format (int)

Static Public Member Functions

static void print_parameter_help (const vcl_string &name)
 Print a list of parameters and proper value ranges.
static void print_parameter_help (const CComPtr< IBaseFilter > &filter)
 Print a list of parameters and proper value ranges.

Private Attributes

bool register_in_rot_
 Enable remote graph viewing with GraphEdit.
bool run_when_ready_
 Immediately run graph after creating it, else wait for run command.
vcl_string save_graph_to_
 Write the filter graph to filename 'save_graph_to_'.
vcl_string device_name_
 Device name.
vcl_string output_filename_
 If non-empty create file writing section in the filter_graph.
GUID target_output_format_
 Target output format, as returned by current_frame.
bool load_filter_defaults_
 Load source filter defaults for values not manually set.
vcl_map< vcl_string,
vpa_property_wrap > 		vpa_properties_
property_wrap< int > output_format_

Detailed Description

Parameter structure for DirectShow input streams.

Enables the configuration of DirectShow source filters through the IAMVideoProcAmp and IAMStreamConfig interfaces.

Example Usage: 

   vidl_dshow_istream = vidl_dshow_istream(vidl_dshow_istream_params()
                                             .set_xxx(xxx));

Definition at line 68 of file vidl_dshow_istream_params.h.

Constructor & Destructor Documentation

vidl_dshow_istream_params::vidl_dshow_istream_params ( void  )

Constructor - default.

Definition at line 170 of file vidl_dshow_istream_params.cxx.

Member Function Documentation

void vidl_dshow_istream_params::configure_filter ( const CComPtr< IBaseFilter > &  source)

Configure the source filter based on the parameters.

Definition at line 179 of file vidl_dshow_istream_params.cxx.

vcl_string vidl_dshow_istream_params::device_name ( ) const [inline]

Definition at line 92 of file vidl_dshow_istream_params.h.

vcl_string vidl_dshow_istream_params::output_filename ( ) const [inline]

Definition at line 93 of file vidl_dshow_istream_params.h.

void vidl_dshow_istream_params::print_parameter_help ( const vcl_string &  name) [static]

Print a list of parameters and proper value ranges.

Definition at line 249 of file vidl_dshow_istream_params.cxx.

void vidl_dshow_istream_params::print_parameter_help ( const CComPtr< IBaseFilter > &  filter) [static]

Print a list of parameters and proper value ranges.

Definition at line 262 of file vidl_dshow_istream_params.cxx.

bool vidl_dshow_istream_params::register_in_rot ( ) const [inline]

Definition at line 89 of file vidl_dshow_istream_params.h.

bool vidl_dshow_istream_params::run_when_ready ( ) const [inline]

Definition at line 90 of file vidl_dshow_istream_params.h.

vcl_string vidl_dshow_istream_params::save_graph_to ( ) const [inline]

Definition at line 91 of file vidl_dshow_istream_params.h.

vidl_dshow_istream_params & vidl_dshow_istream_params::set_device_name ( const vcl_string &  name)

Definition at line 426 of file vidl_dshow_istream_params.cxx.

vidl_dshow_istream_params & vidl_dshow_istream_params::set_load_filter_defaults ( bool  val)

Definition at line 447 of file vidl_dshow_istream_params.cxx.

vidl_dshow_istream_params & vidl_dshow_istream_params::set_output_filename ( const vcl_string &  name)

Definition at line 433 of file vidl_dshow_istream_params.cxx.

vidl_dshow_istream_params & vidl_dshow_istream_params::set_output_format ( int  val)

Definition at line 454 of file vidl_dshow_istream_params.cxx.

vidl_dshow_istream_params & vidl_dshow_istream_params::set_properties ( const vcl_map< vcl_string, vcl_string > &  props)

Set properties from a map(string,value).

See also:
mul/mbl/mbl_read_props.h

Definition at line 338 of file vidl_dshow_istream_params.cxx.

vidl_dshow_istream_params & vidl_dshow_istream_params::set_register_in_rot ( bool  val)

Definition at line 405 of file vidl_dshow_istream_params.cxx.

vidl_dshow_istream_params & vidl_dshow_istream_params::set_run_when_ready ( bool  val)

Definition at line 412 of file vidl_dshow_istream_params.cxx.

vidl_dshow_istream_params & vidl_dshow_istream_params::set_save_graph_to ( const vcl_string &  name)

Definition at line 419 of file vidl_dshow_istream_params.cxx.

vidl_dshow_istream_params & vidl_dshow_istream_params::set_target_output_format ( GUID  val)

Definition at line 440 of file vidl_dshow_istream_params.cxx.

GUID vidl_dshow_istream_params::target_output_format ( ) const [inline]

Definition at line 94 of file vidl_dshow_istream_params.h.

Member Data Documentation

vcl_string vidl_dshow_istream_params::device_name_ [private]

Device name.

Definition at line 120 of file vidl_dshow_istream_params.h.

bool vidl_dshow_istream_params::load_filter_defaults_ [private]

Load source filter defaults for values not manually set.

Definition at line 129 of file vidl_dshow_istream_params.h.

vcl_string vidl_dshow_istream_params::output_filename_ [private]

If non-empty create file writing section in the filter_graph.

Definition at line 123 of file vidl_dshow_istream_params.h.

property_wrap<int> vidl_dshow_istream_params::output_format_ [private]

Definition at line 145 of file vidl_dshow_istream_params.h.

bool vidl_dshow_istream_params::register_in_rot_ [private]

Enable remote graph viewing with GraphEdit.

Definition at line 111 of file vidl_dshow_istream_params.h.

bool vidl_dshow_istream_params::run_when_ready_ [private]

Immediately run graph after creating it, else wait for run command.

Definition at line 114 of file vidl_dshow_istream_params.h.

vcl_string vidl_dshow_istream_params::save_graph_to_ [private]

Write the filter graph to filename 'save_graph_to_'.

Definition at line 117 of file vidl_dshow_istream_params.h.

GUID vidl_dshow_istream_params::target_output_format_ [private]

Target output format, as returned by current_frame.

Definition at line 126 of file vidl_dshow_istream_params.h.

vcl_map<vcl_string,vpa_property_wrap> vidl_dshow_istream_params::vpa_properties_ [private]

Definition at line 132 of file vidl_dshow_istream_params.h.

The documentation for this class was generated from the following files:
Generated on Wed May 1 2013 17:33:02 for core/vidl by   doxygen 1.7.5.1