CBaseControlVideo.GetVideoFormat method
[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The GetVideoFormat method retrieves a video sample that represents the current video format.
Syntax
virtual VIDEOINFOHEADER* GetVideoFormat() = 0;
Parameters
This method has no parameters.
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
| Requirement | Value |
|---|---|
| Header |
|
| Library |
|