DiCE API nvidia_logo_transpbg.gif Up
mi::bridge::IVideo_sink Class Referenceabstract

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

#include <ibridge_video_client.h>

Inheritance diagram for mi::bridge::IVideo_sink:

Public Member Functions

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...
 
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_context_closed (Sint32 reason)=0
 Called when the video context has been closed. More...
 
- Public Member Functions inherited from mi::base::IInterface
virtual Uint32 retain () const =0
 Increments the reference count. More...
 
virtual Uint32 release () const =0
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const =0
 Acquires a const interface from another. More...
 
template<class T>
const T * get_interface () const
 Acquires a const interface from another. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)=0
 Acquires a mutable interface from another. More...
 
template<class T>
T * get_interface ()
 Acquires a mutable interface from another. More...
 
virtual Uuid get_iid () const =0
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xa94825d1, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0xa94825d1, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::IInterface
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface. More...
 

Detailed 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()

Member Function Documentation

 video_context_closed()

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.

 video_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_codeError code specified by the application.
error_messageA short description of the error.

 video_frame()

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_frameThe video frame to display. Can be NULL.
frame_dataAdditional frame data. Can be NULL.

 video_progress()

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
valueA value indicating progress for the area.
areaThe area the progress message is for.
messageA string containing a progress message or some progress data for the area.