Browser Side Plug-in API

  • Revision slug: Gecko_Plugin_API_Reference/Browser_Side_Plug-in_API
  • Revision title: Browser Side Plug-in API
  • Revision id: 75537
  • Created:
  • Creator: Kray2
  • Is current revision? No
  • Comment fixing series category

Revision Content

{{template.PreviousNext("Gecko Plugin API Reference:Plug-in Side Plug-in API", "Gecko Plugin API Reference:Scripting plugins")}} {{template.Npapiref()}}

This chapter describes methods in the plug-in API that are available for the browser. The names of all of these methods begin with NPN_ to indicate that they are implemented by the browser and called by the plug-in. For an overview of how these two sides of the plug-in API interact, see the {{wiki.template('Npapi-section', [ "Plug-in Basics", "How Plug-ins Work" ])}} and {{wiki.template('Npapi-section', [ "Plug-in Basics", "Overview of Plug-in Structure" ])}} sections in the introduction.

Netscape Plug-in Method Summary

{{template.Npapi("NPN_DestroyStream")}}
Closes and deletes a stream.
{{template.Npapi("NPN_ForceRedraw")}}
Forces a paint message for a windowless plug-in.
{{template.Npapi("NPN_GetURL")}}
Asks the browser to create a stream for the specified URL.
{{template.Npapi("NPN_GetURLNotify")}}
Requests creation of a new stream with the contents of the specified URL; gets notification of the result.
{{template.Npapi("NPN_GetValue")}}
Allows the plug-in to query the browser for information.
{{template.Npapi("NPN_InvalidateRect")}}
Invalidates specified drawing area prior to repainting or refreshing a windowless plug-in.
{{template.Npapi("NPN_InvalidateRegion")}}
Invalidates specified drawing region prior to repainting or refreshing a windowless plug-in.
{{template.Npapi("NPN_MemAlloc")}}
Allocates memory from the browser's memory space.
{{template.Npapi("NPN_MemFlush")}}
Requests that the browser free a specified amount of memory.
{{template.Npapi("NPN_MemFree")}}
Deallocates a block of allocated memory.
{{template.Npapi("NPN_NewStream")}}
Requests the creation of a new data stream produced by the plug-in and consumed by the browser.
{{template.Npapi("NPN_PluginThreadAsyncCall")}}
{{template.Gecko_minversion_inline(1.9)}} Thread-safe way to request that the browser calls a plugin function on the browser or plugin thread (the thread on which the plugin was initiated).
{{template.Npapi("NPN_PostURL")}}
Posts data to a URL.
{{template.Npapi("NPN_PostURLNotify")}}
Posts data to a URL, and receives notification of the result.
{{template.Npapi("NPN_ReloadPlugins")}}
Reloads all plug-ins in the Plugins directory.
{{template.Npapi("NPN_RequestRead")}}
Requests a range of bytes for a seekable stream.
{{template.Npapi("NPN_SetValue")}}
Sets windowless plug-in as transparent or opaque.
{{template.Npapi("NPN_Status")}}
Displays a message on the status line of the browser window.
{{template.Npapi("NPN_UserAgent")}}
Returns the browser's user agent field.
{{template.Npapi("NPN_Version")}}
Returns version information for the Plug-in API.
{{template.Npapi("NPN_Write")}}
Pushes data into a stream produced by the plug-in and consumed by the browser.

{{template.PreviousNext("Gecko Plugin API Reference:Plug-in Side Plug-in API", "Gecko Plugin API Reference:Scripting plugins")}}

{{ wiki.languages( { "pl": "pl/Dokumentacja_wtyczek_Gecko/Interfejs_programowania_aplikacji_(API)_od_strony_przegl\u0105darki", "ja": "ja/Gecko_Plugin_API_Reference/Browser_Side_Plug-in_API" } ) }}

Revision Source

<div class="noinclude">
<p>{{template.PreviousNext("Gecko Plugin API Reference:Plug-in Side Plug-in API", "Gecko Plugin API Reference:Scripting plugins")}} {{template.Npapiref()}}
</p>
</div>
<p>This chapter describes methods in the plug-in API that are available for the browser. The names of all of these methods begin with <code>NPN_</code> to indicate that they are implemented by the browser and called by the plug-in. For an overview of how these two sides of the plug-in API interact, see the {{wiki.template('Npapi-section', [ "Plug-in Basics", "How Plug-ins Work" ])}} and {{wiki.template('Npapi-section', [ "Plug-in Basics", "Overview of Plug-in Structure" ])}} sections in the introduction.
</p>
<div class="noinclude">
<h3 name="Netscape_Plug-in_Method_Summary"> Netscape Plug-in Method Summary </h3>
</div>
<dl><dt> {{template.Npapi("NPN_DestroyStream")}}
</dt><dd> Closes and deletes a stream.
</dd><dt> {{template.Npapi("NPN_ForceRedraw")}}
</dt><dd> Forces a paint message for a windowless plug-in.
</dd><dt> {{template.Npapi("NPN_GetURL")}}
</dt><dd> Asks the browser to create a stream for the specified URL.
</dd><dt> {{template.Npapi("NPN_GetURLNotify")}}
</dt><dd> Requests creation of a new stream with the contents of the specified URL; gets notification of the result.
</dd><dt> {{template.Npapi("NPN_GetValue")}}
</dt><dd> Allows the plug-in to query the browser for information.
</dd><dt> {{template.Npapi("NPN_InvalidateRect")}}
</dt><dd> Invalidates specified drawing area prior to repainting or refreshing a windowless plug-in.
</dd><dt> {{template.Npapi("NPN_InvalidateRegion")}}
</dt><dd> Invalidates specified drawing region prior to repainting or refreshing a windowless plug-in.
</dd><dt> {{template.Npapi("NPN_MemAlloc")}}
</dt><dd> Allocates memory from the browser's memory space.
</dd><dt> {{template.Npapi("NPN_MemFlush")}}
</dt><dd> Requests that the browser free a specified amount of memory.
</dd><dt> {{template.Npapi("NPN_MemFree")}}
</dt><dd> Deallocates a block of allocated memory.
</dd><dt> {{template.Npapi("NPN_NewStream")}}
</dt><dd> Requests the creation of a new data stream produced by the plug-in and consumed by the browser.
</dd><dt> {{template.Npapi("NPN_PluginThreadAsyncCall")}}
</dt><dd> {{template.Gecko_minversion_inline(1.9)}} Thread-safe way to request that the browser calls a plugin function on the browser or plugin thread (the thread on which the plugin was initiated).
</dd><dt> {{template.Npapi("NPN_PostURL")}}
</dt><dd> Posts data to a URL.
</dd><dt> {{template.Npapi("NPN_PostURLNotify")}}
</dt><dd> Posts data to a URL, and receives notification of the result.
</dd><dt> {{template.Npapi("NPN_ReloadPlugins")}}
</dt><dd> Reloads all plug-ins in the Plugins directory.
</dd><dt> {{template.Npapi("NPN_RequestRead")}}
</dt><dd> Requests a range of bytes for a seekable stream.
</dd><dt> {{template.Npapi("NPN_SetValue")}}
</dt><dd> Sets windowless plug-in as transparent or opaque.
</dd><dt> {{template.Npapi("NPN_Status")}}
</dt><dd> Displays a message on the status line of the browser window.
</dd><dt> {{template.Npapi("NPN_UserAgent")}}
</dt><dd> Returns the browser's user agent field.
</dd><dt> {{template.Npapi("NPN_Version")}}
</dt><dd> Returns version information for the Plug-in API.
</dd><dt> {{template.Npapi("NPN_Write")}}
</dt><dd> Pushes data into a stream produced by the plug-in and consumed by the browser.
</dd></dl>
<div class="noinclude">
<p>{{template.PreviousNext("Gecko Plugin API Reference:Plug-in Side Plug-in API", "Gecko Plugin API Reference:Scripting plugins")}}
</p>
</div>
{{ wiki.languages( { "pl": "pl/Dokumentacja_wtyczek_Gecko/Interfejs_programowania_aplikacji_(API)_od_strony_przegl\u0105darki", "ja": "ja/Gecko_Plugin_API_Reference/Browser_Side_Plug-in_API" } ) }}
Revert to this revision