NVIDIA Iray API — software examples nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Play_event_handler Class Reference
Inheritance diagram for Play_event_handler:
mi::base::Interface_implement< mi::rtmp::IPlay_event_handler > mi::rtmp::IPlay_event_handler mi::base::Interface_declare< 0x59798950, 0x9a12, 0x48b3, 0x87, 0x14, 0x23, 0xb7, 0x2d, 0xd9, 0xaf, 0x71 > mi::base::IInterface

Public Member Functions

bool handle (bool is_start, mi::rtmp::IStream *stream, mi::neuraylib::IVideo_data **out)
 Called on a play or stop event. More...
 
- Public Member Functions inherited from mi::base::Interface_implement< mi::rtmp::IPlay_event_handler >
 Interface_implement (Uint32 initial=1)
 Constructor. More...
 
 Interface_implement (const Interface_implement< mi::rtmp::IPlay_event_handler > &other)
 Copy constructor. More...
 
Interface_implement
< mi::rtmp::IPlay_event_handler > & 
operator= (const Interface_implement< mi::rtmp::IPlay_event_handler > &other)
 Assignment operator. More...
 
virtual Uint32 retain () const
 Increments the reference count. More...
 
virtual Uint32 release () const
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const
 Acquires a const interface. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)
 Acquires a mutable interface. More...
 
Uuid get_iid () const
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x59798950, 0x9a12, 0x48b3, 0x87, 0x14, 0x23, 0xb7, 0x2d, 0xd9, 0xaf, 0x71 >
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< 0x59798950, 0x9a12, 0x48b3, 0x87, 0x14, 0x23, 0xb7, 0x2d, 0xd9, 0xaf, 0x71 >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Protected Member Functions inherited from mi::base::Interface_implement< mi::rtmp::IPlay_event_handler >
Atom32refcount () const
 Get the current refcount. More...
 
virtual ~Interface_implement ()
 
- Static Protected Member Functions inherited from mi::base::Interface_declare< 0x59798950, 0x9a12, 0x48b3, 0x87, 0x14, 0x23, 0xb7, 0x2d, 0xd9, 0xaf, 0x71 >
static const IInterfaceget_interface_static (const IInterface *iinterface, const Uuid &interface_id)
 
static IInterfaceget_interface_static (IInterface *iinterface, const Uuid &interface_id)
 

Detailed Description

Definition at line 91 of file example_rtmp_server.cpp.

Member Function Documentation

bool Play_event_handler::handle ( bool  is_start,
mi::rtmp::IStream stream,
mi::neuraylib::IVideo_data **  out 
)
inlinevirtual

Called on a play or stop event.

Play/stop events are similar to pause/resume events but are more expensive

The event handler allows to filter play or stop events. If it returns true the render loop for the corresponding stream is affected as follows. If is_start is true the render event handler will be called as often as indicated by the maximum render rate for this stream. If is_start is false the render event handler will not be called anymore. If the play event handler returns false nothing changes.

Play/stop events are similar to pause/resume events but are more expensive w.r.t. the internal state of the RTMP server.

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).
A play handler is optional. If no handler is installed the play command from a video client will be allowed by default.
Parameters
is_starttrue indicates a play event, false indicates a stop event.
streamThe stream on which to start or stop playing.
[out]outPotential initialization/close video frame data can be returned here.
Returns
true if the event should be honored, or false if should be ignored.

Implements mi::rtmp::IPlay_event_handler.

Definition at line 94 of file example_rtmp_server.cpp.


The documentation for this class was generated from the following file: