DiCE API nvidia_logo_transpbg.gif Up
mi::rtmp::IStream_event_handler Class Referenceabstract

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

#include <rtmp.h>

Inheritance diagram for mi::rtmp::IStream_event_handler:

Public Member Functions

virtual bool handle (bool is_create, IStream *stream, const IData *command_arguments)=0
 Called on a stream event. 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< 0x103c7914, ... >
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< 0x103c7914, ... >
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

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

 handle()

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_createIndicates if this is a create or remove event.
streamThe new stream or the one being removed.
command_argumentsThe 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.