mi::bridge::IVideo_frame Class Reference

Represents the data for a single video frame. More...

#include <ibridge_video_client.h>

Inheritance diagram for mi::bridge::IVideo_frame:

Public Member Functions
virtual neuraylib::ICanvas *	get_canvas () const =0
	Returns the canvas that contains the decoded frame data. More...
virtual const char *	get_video_format () const =0
	The video format used when encoding this frame on the server. More...
virtual Float32	get_encode_time () const =0
	The encoding time in seconds. More...
virtual Float32	get_decode_time () const =0
	The decoding time in seconds. More...
virtual Size	get_compressed_size () const =0
	The size of the encoded frame in bytes. More...
virtual IData *	get_video_format_attribute (const char *attribute) const =0
	Returns a video format attribute by name. 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< 0xaf02b8cc, ... >
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< 0xaf02b8cc, ... >
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

Represents the data for a single video frame.

See also

mi::bridge::IVideo_sink::video_frame()

Member Function Documentation

get_canvas()

virtual neuraylib::ICanvas * mi::bridge::IVideo_frame::get_canvas ( ) const

pure virtual

Returns the canvas that contains the decoded frame data.

get_compressed_size()

virtual Size mi::bridge::IVideo_frame::get_compressed_size ( ) const

pure virtual

The size of the encoded frame in bytes.

get_decode_time()

virtual Float32 mi::bridge::IVideo_frame::get_decode_time ( ) const

pure virtual

The decoding time in seconds.

get_encode_time()

virtual Float32 mi::bridge::IVideo_frame::get_encode_time ( ) const

pure virtual

The encoding time in seconds.

get_video_format()

virtual const char * mi::bridge::IVideo_frame::get_video_format ( ) const

pure virtual

The video format used when encoding this frame on the server.

get_video_format_attribute()

virtual IData * mi::bridge::IVideo_frame::get_video_format_attribute ( const char *  attribute ) const

pure virtual

Returns a video format attribute by name.

Currently only the attribute "bitrate" is supported and only for video format "h264".