NVIDIA Iray API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::rtmp::IRender_event_handler Class Referenceabstract

Superclass of all handlers of render events. More...

Inheritance diagram for mi::rtmp::IRender_event_handler:
Inheritance graph
[legend]

Public Member Functions

virtual bool  handle (IStream *stream)=0
  Called on a render event. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xe3f21dfb, 0xe285, 0x4733, 0xab, 0x10, 0x3f, 0x0c, 0x5c, 0x3d, 0xdd, 0x7a >
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< 0xe3f21dfb, 0xe285, 0x4733, 0xab, 0x10, 0x3f, 0x0c, 0x5c, 0x3d, 0xdd, 0x7a >
static bool  compare_iid (const Uuid &iid)
  Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

Superclass of all handlers of render events.

This is a synthetic handler that does not appear in the RTMP Command Messages section of the Adobe RTMP specification [RTMPSPEC10] It allows the RTMP server to implement the render loop. It can be ignored if no rendering is done.

Member Function Documentation

virtual bool mi::rtmp::IRender_event_handler::handle ( IStream stream)
pure virtual

Called on a render event.

Note
The stream parameter is only valid during the call of the handle() method and cannot be stored (even if proper reference counting is used).
Parameters
stream The stream on which the render handler is registered.
Returns
true in case of success, or false if an error occurred and the stream should be stopped by the RTMP server.