WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIPluginStreamListener

IID:df055770-5448-11d2-8164-006008119d7a
Inherits From:nsISupports

The nsIPluginStreamListener interface defines the minimum set of functionality that the browser will support if it allows plugins. Plugins can call QueryInterface to determine if a plugin manager implements more specific APIs or other browser interfaces for the plugin to use (e.g. nsINetworkManager).


Properties

readonly nsPluginStreamType streamType

Gets the type of the stream


Methods

void onDataAvailable ( nsIPluginStreamInfo pluginInfo , nsIInputStream inputStream , PRUint32 length ) void onFileAvailable ( nsIPluginStreamInfo pluginInfo , char* fileName ) void onStartBinding ( nsIPluginStreamInfo pluginInfo ) void onStopBinding ( nsIPluginStreamInfo pluginInfo , nsresult status )

void onDataAvailable ( nsIPluginStreamInfo pluginInfo , nsIInputStream inputStream , PRUint32 length )

Notify the client that data is available in the input stream. This method is called whenver data is written into the input stream by the networking library...

Arguments:
pluginInfo: - plugin stream info
inputStream: - the input stream containing the data. This stream can be either a blocking or non-blocking stream.
length: - the amount of data that was just pushed into the stream.
Returns:
- the return value is currently ignored.

void onFileAvailable ( nsIPluginStreamInfo pluginInfo , char* fileName )

Notify the client that data is available in the file.

Arguments:
pluginInfo: - plugin stream info
fileName: - the name of the file containing the data
Returns:
- the return value is currently ignored.

void onStartBinding ( nsIPluginStreamInfo pluginInfo )

Notify the observer that the URL has started to load. This method is called only once, at the beginning of a URL load.

Arguments:
pluginInfo: - plugin stream info
Returns:
- the return value is currently ignored, in the future it may be used to cancel the URL load..

void onStopBinding ( nsIPluginStreamInfo pluginInfo , nsresult status )

Notify the observer that the URL has finished loading. This method is called once when the networking library has finished processing the URL transaction initiatied via the nsINetService::Open(...) call.

This method is called regardless of whether the URL loaded successfully.

Arguments:
pluginInfo: - plugin stream info
status: - reason why the stream has been terminated
Returns:
- the return value is currently ignored.

References

This interface is passed as an argument to the following methods:

nsIPluginInstance.newStream

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com