CBaseControlVideo::GetVideoFormat

Microsoft DirectShow 9.0

CBaseControlVideo::GetVideoFormat

The GetVideoFormat method retrieves a video sample that represents the current video format.

Syntax

  virtual VIDEOINFOHEADER * GetVideoFormat(void) PURE;

Return Value

Returns a pointer to a VIDEOINFOHEADER structure that contains the current video format.

Remarks

To return and check certain information through IBasicVideo, the object must know the current video format. It gets this information by calling this pure virtual method that derived classes must override. This member function is called by the following CBaseControlVideo member functions.

• CBaseControlVideo::OnVideoSizeChange
• CBaseControlVideo::get_AvgTimePerFrame
• CBaseControlVideo::get_BitRate
• CBaseControlVideo::get_BitErrorRate
• CBaseControlVideo::get_VideoWidth
• CBaseControlVideo::get_VideoHeight
• CBaseControlVideo::GetVideoPaletteEntries
• CBaseControlVideo::GetVideoSize

Requirements

**  Header:** Declared in Ctlutil.h; include Streams.h.

**  Library:** Use Strmbase.lib (retail builds) or Strmbasd.lib (debug builds).

See Also

• CBaseControlVideo Class