Abstract interface to receive video frames produced by the corresponding server-side video context.
More...
#include <ibridge_video_client.h>
|
| typedef Interface_declare< id1, ... > | Self |
| | Own type. More...
|
| |
| typedef Uuid_t< id1, ... > | IID |
| | Declares the interface ID (IID) of this interface. More...
|
| |
| 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 bool | compare_iid (const Uuid &iid) |
| | Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
|
| |
| static bool | compare_iid (const Uuid &iid) |
| | Compares the interface ID iid against the interface ID of this interface. More...
|
| |
Abstract interface to receive video frames produced by the corresponding server-side video context.
- See also
- mi::bridge::IClient_video_context::set_video_sink()
◆ 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_code | Error code specified by the application. |
| error_message | A short description of the error. |
◆ video_frame()
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. |
◆ 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.
This can be used to send progress messages for the frames produced by the server in a manner analogous to progress reporting performed by Iray render contexts.
- 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. |
Public Member Functions inherited from mi::base::IInterface