IWMSPacketStreamer::GetStreamInfo
.gif)
| Previous | Next |
IWMSPacketStreamer::GetStreamInfo
The GetStreamInfo method is called by the server to retrieve header information on streams that are being sent down the data path.
Syntax
HRESULT GetStreamInfo( );
Parameters
pCallback
[in] Pointer to an IWMSPacketStreamerCallback interface used to report the status of the method call.
qwContext
[in] QWORD containing a value defined by the server to identify which call to GetStreamInfo the plug-in is responding to when it calls IWMSPacketStreamerCallback::OnGetStreamInfo. You must pass this value back unaltered.
Return Values
If the method succeeds, the plug-in must return S_OK. To report an error, the plug-in can return any HRESULT other than S_OK. If the plug-in uses the IWMSEventLog interface to log error information directly to the Windows Event Viewer, it is recommended that it return NS_E_PLUGIN_ERROR_REPORTED. Typically, the server attempts to make plug-in error information available to the server object model, the Windows Event Viewer, and the troubleshooting list in the details pane of the Windows Media Services MMC. However, if the plug-in uses the IWMSEventLog interface to send custom error information to the Windows Event Viewer, returning NS_E_PLUGIN_ERROR_REPORTED stops the server from also logging to the event viewer. For more information about retrieving plug-in error information, see Identifying Plug-in Errors.
Remarks
This method is called by the server and implemented by media parser, data source, and data sink plug-ins. If this method returns S_OK, and if it does not call GetStreamInfo on an upstream module in which it passes in the original arguments, the IWMSPacketStreamerCallback::OnGetStreamInfo method must be called.
The GetStreamInfo method is called every time a source stream changes. For example, it is called once for a simple movie file, and it is called once for each media item in a server-side playlist.
Example Code
Requirements
Header: wmsdatapath.h.
Library: WMSServerTypeLib.dll.
Platform: Windows Server 2003, Enterprise Edition; Windows Server 2003, Datacenter Edition; Windows Server 2008.
See Also
| Previous | Next |