NPAPI:AudioControl: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(Modify to reflect the flash beta push API implementation)
Line 5: Line 5:
= Contributors =
= Contributors =


* Last modified: August 14, 2011
* Last modified: June 1, 2015
* Authors: Kyle Huey (Mozilla)
* Authors: Kyle Huey (Mozilla), Benoit Girard (Mozilla)
* Contributors:  
* Contributors:  
= Changes =
Modified in 2015 to be push API instead of a pull API and to use Get/SetValue.


= Use case =
= Use case =
Line 17: Line 21:


<pre>
<pre>
NPBool NPP_IsInstancePlayingAudio(NPP instance);
NPPVpluginIsPlayingAudio = 4000
</pre>
</pre>


This function returns TRUE if the plugin instance 'instance' is currently playing audio and FALSE if the plugin instance 'instance' is not.  This function may only be called when at least one instance of a plugin has been created and not destroyed and 'instance' must be a live plugin instance when called.
This NPPVariable, when set via NPN_SetValue, will let the plugin instance signal via a BOOL if the current instance is currently playing audio.


== Mute/Unmute a plugin instance ==
== Mute/Unmute a plugin instance ==


<pre>
<pre>
NPError NPP_MuteInstance(NPP instance);
NPNVmuteAudioBool = 4000
NPError NPP_UnmuteInstance(NPP instance);
</pre>
</pre>


These functions mute or unmute (respectively) the plugin instance 'instance'.  These functions may only be called when at least one instance of a plugin has been created and not destroyed and 'instance' must be a live plugin instance when called.
This NPNVariable, when set via NPP_SetValue, will let the browser notify the plugin that it should mute audio for the current plugin instance.


= Open issues =
= Open issues =
* Should we condense NPP_[Mute|Unmute]Instance into a single function taking a boolean mute/unmute argument?
* Will we want to be able to control the volume level on a per instance basis?  This seems unnecessarily complicated.
* Will we want to be able to control the volume level on a per instance basis?  This seems unnecessarily complicated.

Revision as of 23:20, 1 June 2015

Status

Drafting.

Contributors

  • Last modified: June 1, 2015
  • Authors: Kyle Huey (Mozilla), Benoit Girard (Mozilla)
  • Contributors:

Changes

Modified in 2015 to be push API instead of a pull API and to use Get/SetValue.

Use case

The ability to mute/unmute tabs or determine which tabs are playing audio is a commonly requested feature in web browsers. This specification allows browsers to mute/unmute instances of cooperating plugins and determine which instances are playing audio. Browsers can use these APIs to implement per-tab audio control.

Proposed Specification

Determine if an instance is playing audio

NPPVpluginIsPlayingAudio = 4000

This NPPVariable, when set via NPN_SetValue, will let the plugin instance signal via a BOOL if the current instance is currently playing audio.

Mute/Unmute a plugin instance

NPNVmuteAudioBool = 4000

This NPNVariable, when set via NPP_SetValue, will let the browser notify the plugin that it should mute audio for the current plugin instance.

Open issues

  • Will we want to be able to control the volume level on a per instance basis? This seems unnecessarily complicated.
Retrieved from "https://wiki.mozilla.org/index.php?title=NPAPI:AudioControl&oldid=1077796"