MFInitVideoFormat function (mfapi.h)

[This API is not supported and may be altered or unavailable in the future. Applications should avoid using the MFVIDEOFORMAT structure, and use media type attributes instead. For more information, see Video Media Types.]

Initializes an MFVIDEOFORMAT structure for a standard video format such as DVD, analog television, or ATSC digital television.

Syntax

HRESULT MFInitVideoFormat(
  [out] MFVIDEOFORMAT         *pVideoFormat,
  [in]  MFStandardVideoFormat type
);

Parameters

[out] pVideoFormat

A pointer to an MFVIDEOFORMAT structure. The function fills in the structure members based on the video format specified in the type parameter.

[in] type

The video format, specified as a member of the MFStandardVideoFormat enumeration.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Examples

The following example creates a media type object for a standard video format.

// Creates a media type for a standard video format.
HRESULT CreateStandardVideoMediaType(MFStandardVideoFormat type, IMFMediaType **ppMediaType)
{
    IMFMediaType *pMediaType = NULL;

    MFVIDEOFORMAT format;

    // Fill in the MFVIDEOFORMAT structure for the video format.
    HRESULT hr = MFInitVideoFormat(&format, type);
    if (FAILED(hr))
    {
        goto done;
    }

    // Create a new (empty) media type.
    hr = MFCreateMediaType(&pMediaType);
    if (FAILED(hr))
    {
        goto done;
    }

    // Initialize the media type from the MFVIDEOFORMAT structure.
    hr = MFInitMediaTypeFromMFVideoFormat(pMediaType, &format, sizeof(format));
    if (FAILED(hr))
    {
        goto done;
    }

    // Return the pointer to the caller.
    *ppMediaType = pMediaType;
    (*ppMediaType)->AddRef();

done:
    SafeRelease(&pMediaType);
    return hr;
}

Requirements

See also

Media Foundation Functions

Media Types

Video Media Types