Representing an RTMP stream. More...
#include <rtmp.h>
Public Member Functions | |
| virtual bool | use_codec (const char *name)=0 |
| Tells the RTMP server which codec will be used on the stream. More... | |
| virtual neuraylib::IVideo_encoder * | get_video_codec ()=0 |
| Returns the video codec for this stream. More... | |
| virtual void | register_render_event_handler (IRender_event_handler *render_event_handler)=0 |
| Registers the render event handler. More... | |
| virtual void | register_frame_event_handler (IFrame_event_handler *frame_event_handler)=0 |
| Registers the frame event handler. More... | |
| virtual void | register_play_event_handler (IPlay_event_handler *play_event_handler)=0 |
| Registers the play event handler. More... | |
| virtual void | register_pause_event_handler (IPause_event_handler *pause_event_handler)=0 |
| Registers the pause event handler. More... | |
| virtual const char * | get_stream_name () const =0 |
| Returns the name of the current playing stream. More... | |
| virtual Sint32 | set_property (const char *key, const char *value)=0 |
| Sets a property on the stream. More... | |
| virtual const char * | get_property (const char *key) const =0 |
| Returns a property from the stream. More... | |
| virtual IConnection * | get_connection ()=0 |
| Returns the connection for this stream. 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 IInterface * | get_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 IInterface * | get_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< 0xa6532316, ... > | |
| 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< 0xa6532316, ... > | |
| 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... | |
Representing an RTMP stream.
|
pure virtual |
Returns the connection for this stream.
Useful for registering specific remote call handlers.
|
pure virtual |
Returns a property from the stream.
| key | The key to obtain the value for. |
NULL if it does not exist.
|
pure virtual |
Returns the name of the current playing stream.
This is the name passed in as an argument by the RTMP player in the RTMP protocol play message.
NULL if not applicable.
|
pure virtual |
Returns the video codec for this stream.
The method use_codec() must be called first to set the video code for this stream.
|
pure virtual |
Registers the frame event handler.
| frame_event_handler | The frame event handler to install. The value NULL removes the installed handler. |
|
pure virtual |
Registers the pause event handler.
| pause_event_handler | The pause event handler to install. The value NULL removes the installed handler. |
|
pure virtual |
Registers the play event handler.
| play_event_handler | The play event handler to install. The value NULL removes the installed handler. |
|
pure virtual |
Registers the render event handler.
| render_event_handler | The render event handler to install. The value NULL removes the installed handler. |
|
pure virtual |
Sets a property on the stream.
Currently, the only reserved system property is "render_rate". It indicates how often the RTMP server will try to call the registered render event handler. Bandwidth throttling and longer render times make this rate a not always reachable target. If this variable is left unset by the user the RTMP server will try to find a suitable default.
"user_" to avoid future name clashes.| key | The key to set the value for. |
| value | The value of the property |
|
pure virtual |
Tells the RTMP server which codec will be used on the stream.
If no codec is set the data passed via the IFrame_event_handler will be sent out as is without any RTMP encapsulation.
| name | The name of the codec to use, for example "screen video", "sorenson" or "h264". |
true if that codec is supported, i.e., the RTMP server has support for this codec (possibly through a video plugin) and the codec is one of the supported formats within an RTMP stream.