neuray API Programmer's Manual

mi::bridge::IVideo_sink Class Reference

[Bridge client]

Description

Abstract interface to receive video frames produced by the corresponding server-side video context.

See also:

mi::bridge::IClient_video_context::set_video_sink()

mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

virtual void video_context_closed( Sint32 reason) =0
Called when the video context has been closed. More...
virtual void video_error( Sint32 error_code, const char* error_message) =0
Called if rendering or encoding on the server failed. More...
virtual void video_frame( IVideo_frame* video_frame, neuraylib::​IBuffer* frame_data) =0
Called when a frame has arrived from the corresponding server side video context. More...
virtual void video_progress( Float64 value, const char* area, const char* message) =0
Called when progress messages arrive for the next frame from the server-side video source. More...

Member Functions

virtual void mi::​bridge::​IVideo_sink::video_context_closed( Sint32 reason) [pure virtual]

Called when the video context has been closed.

Parameters

reason
  • 0: Closed by the client.
  • 1: Closed by the server.
  • -1: Network error.
virtual void mi::​bridge::​IVideo_sink::video_error( Sint32 error_code, const char* error_message) [pure virtual]

Called if rendering or encoding on the server failed.

Parameters

error_code
Error code specified by the application.
error_message
A short description of the error.
virtual void mi::​bridge::​IVideo_sink::video_frame( IVideo_frame* video_frame, neuraylib::​IBuffer* frame_data) [pure virtual]

Called when a frame has arrived from the corresponding server side video context. The frame_data buffer is specified by the server-side application when the frame is produced and can contain any kind of additional information about the frame. For applications that are not video-centric, the frame data can also be sent instead of a video frame. The raw data buffer will be delivered to the client as is (not encoded or compressed in any way) and it is up to the application to define the format of the data.

Parameters

video_frame
The video frame to display. Can be NULL.
frame_data
Additional frame data. Can be NULL.
virtual void mi::​bridge::​IVideo_sink::video_progress( Float64 value, const char* area, const char* message) [pure virtual]

Called when progress messages arrive for the next frame from the server-side video source.

Parameters

value
A value indicating progress for the area.
area
The area the progress message is for.
message
A string containing a progress message or some progress data for the area.