Package Torello.Browser
Class WebAudio
- java.lang.Object
-
- Torello.Browser.WebAudio
-
public class WebAudio extends java.lang.Object
Class created byAutomatic Code-Generator
.
This class was built using the Chrome Remote Dev-Tools A.P.I., which is specified by two JSON-RPC Files. These files were obtained from the Chrome Dev Tools Protocol Git Hub Page, which has a "Tip of Tree" (the latest) API-Specification Page Here: JSON-RPC Protocol Specification.
JSON-Viewable Google-API:
These files may be viewed here: browser_protocol.json and js_protocol.json.
These files were converted into this Java-Browser (CDT) Library; they are a Java-Alternative to the Node.js implementation.
HTML-Viewable API:
In addition to this Class-Library, these files were also converted to a simple HTML Page, which may be browsed here: Browser API Web-PageNode.js
RDP-API Implementation:
You may read about theNode.js Chrome Remote Interface
on the Node.js Package Manager Web-Site: NPM
This domain allows inspection of Web Audio API. https://webaudio.github.io/web-audio-api/This class is intended to be used with a Headless Browser
These methods have been tested, to some degree, using Google Chrome. In order to use this class you must start a web-browser instance and make a connection to the browser using aRemote Debugging Port
. The initializations may be accomplished using classBRDPC
(Browser Remote Debug Protocol Connection).
Google-Chrome was used during the development process of the classes in this particular package. Note that, lately, it has been asserted Microsoft has switched to using the Chrome-Engine for its Microsoft Edge Browser Internal Code-Base. Therefore, there may limited support / functionality when running the methods in this class with Microsoft-Edge. There is the possibility these will work with Opera & Safari.
Check whether the your Web-Browser will allow itself to be driven by theWeb-Socket RDP-Port 9223
.
Foreign Function API:
Every one of the methods that reside in this class are designed to do nothing more than:- Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
- Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket RDP Connection
- Receive BOTH that Method's Results AND any Browser Event-Firings from the Web-Socket
- Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
- Report these Method-Results and Browser-Events to the User via an User-Registered Event-Listener or a Promise Object
Java-HTML Difference:
Unlike the bulk of the Java HTML JAR Library, there is very little native Java-Code, and very little testing that may be done on any of the classes & methods in this package. The code inside these classes does nothing more than marshall-and-unmarshall Java-Types into Json-Requests (and vice-versa). The Java-Script & Browser modules inside of a Google-Chrome instance are, theoretically, handling these requests, and returning their results (or events) over the Web-Socket Connection.
It has been asserted (by Google Chrome Developers) that some of these methods are only "partially working" or "experimental".
Hi-Lited Source-Code:- View Here: Torello/Browser/WebAudio.java
- Open New Browser-Tab: Torello/Browser/WebAudio.java
File Size: 72,324 Bytes Line Count: 1,846 '\n' Characters Found
Stateless Class:This class neither contains any program-state, nor can it be instantiated. The@StaticFunctional
Annotation may also be called 'The Spaghetti Report'.Static-Functional
classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's@Stateless
Annotation.
- 1 Constructor(s), 1 declared private, zero-argument constructor
- 3 Method(s), 3 declared static
- 10 Field(s), 10 declared static, 9 declared final
- Fields excused from final modifier (with explanation):
Field 'counter' is not final. Reason: CONFIGURATION
-
-
Nested Class Summary
Type Classes: WebAudio Domain Types Modifier and Type Inner-Class static class
WebAudio.AudioListener
Protocol object for AudioListenerstatic class
WebAudio.AudioNode
Protocol object for AudioNodestatic class
WebAudio.AudioParam
Protocol object for AudioParamstatic class
WebAudio.BaseAudioContext
Protocol object for BaseAudioContextstatic class
WebAudio.ContextRealtimeData
Fields in AudioContext that change in real-time.Event Classes: WebAudio Domain Events Modifier and Type Inner-Class static class
WebAudio.audioListenerCreated
Notifies that the construction of an AudioListener has finished.static class
WebAudio.audioListenerWillBeDestroyed
Notifies that a new AudioListener has been created.static class
WebAudio.audioNodeCreated
Notifies that a new AudioNode has been created.static class
WebAudio.audioNodeWillBeDestroyed
Notifies that an existing AudioNode has been destroyed.static class
WebAudio.audioParamCreated
Notifies that a new AudioParam has been created.static class
WebAudio.audioParamWillBeDestroyed
Notifies that an existing AudioParam has been destroyed.static class
WebAudio.contextChanged
Notifies that existing BaseAudioContext has changed some properties (id stays the same)..static class
WebAudio.contextCreated
Notifies that a new BaseAudioContext has been created.static class
WebAudio.contextWillBeDestroyed
Notifies that an existing BaseAudioContext will be destroyed.static class
WebAudio.nodeParamConnected
Notifies that an AudioNode is connected to an AudioParam.static class
WebAudio.nodeParamDisconnected
Notifies that an AudioNode is disconnected to an AudioParam.static class
WebAudio.nodesConnected
Notifies that two AudioNodes are connected.static class
WebAudio.nodesDisconnected
Notifies that AudioNodes are disconnected.
-
Field Summary
WebAudio Domain Enumerated String Types Modifier and Type Field static String[]
AutomationRate
Enum of AudioParam::AutomationRate from the specstatic String[]
ChannelCountMode
Enum of AudioNode::ChannelCountMode from the specstatic String[]
ChannelInterpretation
Enum of AudioNode::ChannelInterpretation from the specstatic String[]
ContextState
Enum of AudioContextState from the specstatic String[]
ContextType
Enum of BaseAudioContext types
-
Method Summary
WebAudio Domain Commands Script Returns Modifier and Type Method NONE ( void
)static Script<>
disable()
Disables the WebAudio domain.NONE ( void
)static Script<>
enable()
Enables the WebAudio domain and starts sending context lifetime events.WebAudio.ContextRealtimeData
static Script<>
getRealtimeData(String contextId)
Fetch the realtime data from the registered contexts.
-
-
-
Field Detail
-
ContextType
public static final java.lang.String[] ContextType
Enum of BaseAudioContext types
-
ContextState
public static final java.lang.String[] ContextState
Enum of AudioContextState from the spec
-
ChannelCountMode
public static final java.lang.String[] ChannelCountMode
Enum of AudioNode::ChannelCountMode from the spec
-
ChannelInterpretation
public static final java.lang.String[] ChannelInterpretation
Enum of AudioNode::ChannelInterpretation from the spec
-
AutomationRate
public static final java.lang.String[] AutomationRate
Enum of AudioParam::AutomationRate from the spec
-
-
Method Detail
-
enable
public static Script<java.lang.String,JsonObject,Ret0> enable()
Enables the WebAudio domain and starts sending context lifetime events.- Returns:
- An instance of
Script
<String,JsonObject
,Ret0
>
ThisScript
instance must be executed before the browser receives the invocation-request.
This Browser-Function does not have a return-value. You may choose to await thePromise
<JsonObject,
Ret0
>
to ensure the Browser Function has run to completion.
-
disable
public static Script<java.lang.String,JsonObject,Ret0> disable()
Disables the WebAudio domain.- Returns:
- An instance of
Script
<String,JsonObject
,Ret0
>
ThisScript
instance must be executed before the browser receives the invocation-request.
This Browser-Function does not have a return-value. You may choose to await thePromise
<JsonObject,
Ret0
>
to ensure the Browser Function has run to completion.
-
getRealtimeData
public static Script<java.lang.String,JsonObject,WebAudio.ContextRealtimeData> getRealtimeData (java.lang.String contextId)
Fetch the realtime data from the registered contexts.- Parameters:
contextId
- -- Returns:
- An instance of
Script
<String,JsonObject
,WebAudio.ContextRealtimeData
>
This script may be executed, usingScript.exec()
, and afterwards, aPromise
<JsonObject,
will be returned.WebAudio.ContextRealtimeData
>
Finally, thePromise
may be awaited, usingPromise.await()
, and the returned result of this Browser Function may may be retrieved.
This Browser Function returns
)WebAudio.ContextRealtimeData
(realtimeData
-
-
-