Click or drag to resize
RenderAreaListenerOnRequestedFrame Method

Triggered when a new frame is requested by a connection.

Namespace: OIV.RemoteViz.Rendering
Assembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public virtual void OnRequestedFrame(
	RenderArea renderArea,
	Connection sender,
	SbRasterImage rasterImage,
	out bool isInteractive
)

Parameters

renderArea
Type: OIV.RemoteViz.RenderingRenderArea

: the OIV.RemoteViz.Rendering.RenderArea of the OIV.RemoteViz.Rendering.Connection

sender
Type: OIV.RemoteViz.RenderingConnection

: the connection that requests a new frame

rasterImage
Type: OIV.Inventor.ImageSbRasterImage

: contains the RGB raster image to render.

isInteractive
Type: SystemBoolean

: This value can be modified to indicate if an user interaction is in progress. Default value is true. If true (interactive frame), the frame will be compressed with the interactive frame encoder and a quality adapted to the bandwidth setting. If false (still frame), the frame will be compressed with the still frame encoder and the best available quality.

Remarks

This method only works when the OIV.RemoteViz.Rendering.ServiceSettings.RunModes.INDEPENDENT_SERVICE mode is enabled.

To send a new frame to the client, set the pixel buffer of the raster image using a buffer object. If the buffer object of the raster image is NULL, no frame will be sent to the client. IMPORTANT: This callback is executed in a separate thread for each connection requesting a frame.

See Also