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

Superclass of all handlers of create stream events. More...

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

Public Member Functions

virtual bool  handle (bool is_create, IStream *stream, const IData *command_arguments)=0
  Called on a stream event. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x103c7914, 0xe2be, 0x43aa, 0xa6, 0xc7, 0x23, 0xdd, 0x10, 0x5e, 0xb5, 0x61 >
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< 0x103c7914, 0xe2be, 0x43aa, 0xa6, 0xc7, 0x23, 0xdd, 0x10, 0x5e, 0xb5, 0x61 >
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 create stream events.

A subclass gets registered via mi::rtmp::IConnection::register_stream_event_handler() and will be called in the case of a create stream event or when the stream is removed.

Member Function Documentation

virtual bool mi::rtmp::IStream_event_handler::handle ( bool  is_create,
IStream stream,
const IData command_arguments 
)
pure virtual

Called on a stream 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
is_create Indicates if this is a create or remove event.
stream The new stream or the one being removed.
command_arguments The command object from the client.
Returns
If is_create is false, the return value is ignored. If is_create is true, the return value indicates whether the stream shall get created.