Abstract interface to generate video frames that are transmitted to the corresponding client-side video context. More...
Public Member Functions | |
virtual Sint32 | video_get_next_frame (neuraylib::ICanvas **frame, neuraylib::IBuffer **data)=0 |
Returns data for the next frame. More... |
|
virtual void | video_error (Sint32 error_code, const char *message)=0 |
Called if the video context failed to encode or send the last frame delivered by a call to video_get_next_frame(). More... |
|
virtual void | video_context_closed (Sint32 reason)=0 |
Called when the video context has been closed. More... |
|
Additional Inherited Members | |
Public Types inherited from mi::base::Interface_declare< 0x972224a4, 0xa63b, 0x42ce, 0x96, 0xfe, 0xe1, 0x33, 0xf9, 0x81, 0x1c, 0x64 > | |
typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface > |
Self |
Own type. More... |
|
typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 > |
IID |
Declares the interface ID (IID) of this interface. More... |
|
Static Public Member Functions inherited from mi::base::Interface_declare< 0x972224a4, 0xa63b, 0x42ce, 0x96, 0xfe, 0xe1, 0x33, 0xf9, 0x81, 0x1c, 0x64 > | |
static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... |
|
Abstract interface to generate video frames that are transmitted to the corresponding client-side video context.
|
pure virtual |
Called when the video context has been closed.
reason |
|
|
pure virtual |
Called if the video context failed to encode or send the last frame delivered by a call to video_get_next_frame().
error_code |
|
message | A short description of the error. |
|
pure virtual |
Returns data for the next frame.
The Bridge video protocol calls this method in response to a call to mi::bridge::IServer_video_context::frame_ready().
The data
buffer can contain data associated with the canvas, or, if it suits the application more, it can be sent instead of a canvas. 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.
*frame
and *data
must not be modified until the next call of this method.[out] | frame | The frame to send. Can be NULL if only data is to be sent. If frame and data are NULL , nothing will be sent. |
[out] | data | The optional data to send. Can be NULL if only a frame is to be sent. If frame and data are NULL , nothing will be sent. |