Initiates a websocket connection to Vertex's streaming API. Returns a promise that resolves once the connection is established and can begin accepting messages.
A function that returns a description of how to establish a WS connection.
Optionalsettings: SettingsA configuration to use when initializing the WS connection.
Sends a request to perform an alteration to a scene. Alterations include changing item visibility and changing the materials of items.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The payload of the request.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
Closes any open WS connections and disposes of resources.
Sends a request to tell the rendering pipeline that an interaction has ended.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
Optionalpayload: IEndInteractionPayloadOptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
Sends a request to update the position of the scene's camera as a fly operation
The payload accepts an optional frameCorrelationId that will be sent
back on the frame that is associated to this request. Use onRequest to
add a callback that'll be invoked when the server sends a request to draw
the frame.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
OptionalwithResponse: booleanSends a request to perform hit detection.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The payload of the request.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
OptionalcameraType: FrameCameraTypeSends a request to update the current scene view with the state present in the specified scene view state.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
OptionalwithResponse: booleanAdds a callback that is invoked when the websocket connection is closed.
A handler function.
Adds a callback that is invoked when the client receives an event from the
server. Returns a Disposable that can be used to remove the listener.
A handler function.
Adds a callback that is invoked when the client receives a request from the
server. Returns a Disposable that can be used to remove the listener.
A handler function.
Sends a request to reconnect to an existing streaming session.
The payload accepts an optional frameCorrelationId that will be sent
back on the frame that is associated to this request. Use onRequest to
add a callback that'll be invoked when the server sends a request to draw
the frame.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The payload of the request.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
Sends a request to record performance timings that were measured in the client. The server may use these timings as hints to optimize the rendering performance to provide a better experience.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The request payload
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
Sends a request to retrieve a new token. This token can be used to authenticate with other Vertex services.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
A promise that completes with the refreshed token.
Sends a request to update the position of the scene's camera.
The payload accepts an optional frameCorrelationId that will be sent
back on the frame that is associated to this request. Use onRequest to
add a callback that'll be invoked when the server sends a request to draw
the frame.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The payload of the request.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
Acknowledges a failed request by sending a reply back to the server.
The ID of the received request.
An error to reply with.
Acknowledges a successful request by sending a reply back to the server with an optional result body.
The ID of the received request.
A result to reply with.
Sends a request to reset all overrides for a given scene and optionally to reset the camera to that of the base scene.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The payload of the request.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
Sends a request to initiate a streaming session.
The payload accepts an optional frameCorrelationId that will be sent
back on the frame that is associated to this request. Use onRequest to
add a callback that'll be invoked when the server sends a request to draw
the frame.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The payload of the request.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
Sends a request to sync the clocks between the client and server.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The request payload.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
Sends a request to update the cross sectioning planes of the frame.
The payload accepts an optional frameCorrelationId that will be sent
back on the frame that is associated to this request. Use onRequest to
add a callback that'll be invoked when the server sends a request to draw
the frame.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The payload of the request.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
Sends a request to update the dimensions of the frame.
The payload accepts an optional frameCorrelationId that will be sent
back on the frame that is associated to this request. Use onRequest to
add a callback that'll be invoked when the server sends a request to draw
the frame.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The payload of the request.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
Sends a request to update the specified interaction.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The payload of the request.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
Sends a request to set or clear the model view of the frame.
The payload accepts an optional frameCorrelationId that will be sent
back on the frame that is associated to this request. Use onRequest to
add a callback that'll be invoked when the server sends a request to draw
the frame.
Use withResponse to indicate if the server should reply with a response.
If false, the returned promise will complete immediately. Otherwise,
it'll complete when a response is received.
The payload of the request.
OptionalwithResponse: booleanIndicates if the server should reply with a response.
Defaults to true.
OptionalwithResponse: boolean
Sends a request to signal to the rendering pipeline that an interaction has started. The rendering pipeline will use this as a hint to perform more aggressive rendering optimizations at the expense of rendering quality. Call
endInteractionto signal to the rendering pipeline that an interaction has finished.Use
withResponseto indicate if the server should reply with a response. Iffalse, the returned promise will complete immediately. Otherwise, it'll complete when a response is received.