Microsoft DirectX 8.0 |
Retrieves metadata from a stream. Applications can use this interface to retrieve information encoded into a stream, such as the author, title, and copyright. This interface is typically exposed by parser filters, such as the AVI Splitter and the MPEG-1 Stream Splitter.
Depending on the stream type, a filter might support a subset of the methods on this interface. For example, the AVI Splitter retrieves the copyright, author name, and title from INFO chunks in the AVI file. The remaining methods return E_NOTIMPL.
IUnknown methods Description QueryInterface Retrieves pointers to supported interfaces. AddRef Increments the reference count. Release Decrements the reference count. IDispatch methods Description GetTypeInfoCount Determines whether type information is available for this dispinterface. GetTypeInfo Retrieves the type information for this dispinterface if GetTypeInfoCount returns successfully. GetIDsOfNames Converts text names of properties and methods, including arguments, to their corresponding dispatch identifiers (DISPIDs). Invoke Calls a method or accesses a property in this dispinterface if given a DISPID and any other necessary parameters. IAMMediaContent methods Description get_AuthorName Retrieves the author name. get_Title Retrieves the title. get_Rating Retrieves the rating. get_Description Retrieves a description of the content. get_Copyright Retrieves copyright information. get_BaseURL Retrieves a base URL for the related Web content. get_LogoURL Retrieves a URL for the logo. get_LogoIconURL Retrieves a URL for the logo icon. get_WatermarkURL Retrieves a URL for the watermark. get_MoreInfoURL Retrieves a URL for additional information about the content. get_MoreInfoBannerImage Retrieves an image for a related-information banner. get_MoreInfoBannerURL Retrieves a URL for a related-information banner. get_MoreInfoText Retrieves additional information as text.
Retrieves the author name.
Syntax
HRESULT get_AuthorName( BSTR *pbstrAuthorName );
Parameters
- pbstrAuthorName
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves the title.
Syntax
HRESULT get_Title( BSTR *pbstrTitle );
Parameters
- pbstrTitle
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves the rating.
Syntax
HRESULT get_Rating( BSTR *pbstrRating );
Parameters
- pbstrRating
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves a description of the content.
Syntax
HRESULT get_Description( BSTR *pbstrDescription );
Parameters
- pbstrDescription
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves copyright information.
Syntax
HRESULT get_Copyright( BSTR *pbstrCopyright );
Parameters
- pbstrCopyright
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves a base URL for the related Web content.
Syntax
HRESULT get_BaseURL( BSTR *pbstrBaseURL );
Parameters
- pbstrBaseURL
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves a URL for the logo.
Syntax
HRESULT get_LogoURL( BSTR *pbstrLogoURL );
Parameters
- pbstrLogoURL
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves a URL for the logo icon.
Syntax
HRESULT get_LogoIconURL( BSTR *pbstrLogoURL );
Parameters
- pbstrLogoURL
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves a URL for the watermark.
Syntax
HRESULT get_WatermarkURL( BSTR *pbstrWatermarkURL );
Parameters
- pbstrWatermarkURL
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves a URL for additional information about the content.
Syntax
HRESULT get_MoreInfoURL( BSTR *pbstrMoreInfoURL );
Parameters
- pbstrMoreInfoURL
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves an image for a related-information banner.
Syntax
HRESULT get_MoreInfoBannerImage( BSTR *pbstrMoreInfoBannerImage );
Parameters
- pbstrMoreInfoBannerImage
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves a URL for a related-information banner.
Syntax
HRESULT get_MoreInfoBannerURL( BSTR *pbstrMoreInfoBannerURL );
Parameters
- pbstrMoreInfoBannerURL
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.
Retrieves additional information as text.
Syntax
HRESULT get_MoreInfoText( BSTR *pbstrMoreInfoText );
Parameters
- pbstrMoreInfoText
- Pointer to a variable that receives a BSTR with the information.
Return Value
Returns an HRESULT value. Possible values include those shown in the following table.
S_OK Success. E_NOTIMPL Not implemented. E_OUTOFMEMORY Insufficient memory. VFW_E_NOT_FOUND Item not found.
Remarks
If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.