nsIPluginInstancePeer

IID:4b7cea20-019b-11d2-815b-006008119d7a
Inherits From:nsISupports

The nsIPluginInstancePeer interface is the set of operations implemented by the browser to support a plugin instance. When a plugin instance is constructed, a nsIPluginInstancePeer is passed to its initializer representing the instantiation of the plugin on the page.

Other interfaces may be obtained from nsIPluginInstancePeer by calling QueryInterface, e.g. nsIPluginTagInfo.


Properties

readonly nsMIMEType MIMEType

Returns the MIME type of the plugin instance.

(Corresponds to NPP_New's MIMEType argument.)

readonly nsPluginMode mode

Returns the mode of the plugin instance, i.e. whether the plugin is embedded in the html, or full page.

(Corresponds to NPP_New's mode argument.)


Methods

void getValue ( inInstancePeerVariable variable , voidPtr* value ) void newStream ( nsMIMEType type , char* target , out nsIOutputStream result ) void setWindowSize ( PRUint32 width , PRUint32 height ) void showStatus ( char* message )

void getValue ( inInstancePeerVariable variable , voidPtr* value )

Returns the value of a variable associated with the plugin manager.

(Corresponds to NPN_GetValue.)

Arguments:
variable: - the plugin manager variable to get
value: - the address of where to store the resulting value

void newStream ( nsMIMEType type , char* target , out nsIOutputStream result )

This operation is called by the plugin instance when it wishes to send a stream of data to the browser. It constructs a new output stream to which the plugin may send the data. When complete, the Close and Release methods should be called on the output stream.

(Corresponds to NPN_NewStream.)

Arguments:
type: - MIME type of the stream to create
target: - the target window name to receive the data
result: - the resulting output stream

void setWindowSize ( PRUint32 width , PRUint32 height )

Set the desired size of the window in which the plugin instance lives.

Arguments:
width: - new window width
height: - new window height

void showStatus ( char* message )

This operation causes status information to be displayed on the window associated with the plugin instance.

(Corresponds to NPN_Status.)

Arguments:
message: - the status message to display

References

This interface is the type of the following properties:

nsIPluginInstance.peer

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

nsIPluginInstance.initialize

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com