NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::bridge::IVideo_frame Class Referenceabstract

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

Inheritance diagram for mi::bridge::IVideo_frame:
Inheritance graph
[legend]

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...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xaf02b8cc, 0x772f, 0x4415, 0x95, 0xae, 0x8c, 0xb4, 0xa3, 0xf6, 0xd9, 0xdd >
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< 0xaf02b8cc, 0x772f, 0x4415, 0x95, 0xae, 0x8c, 0xb4, 0xa3, 0xf6, 0xd9, 0xdd >
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

Represents the data for a single video frame.

See Also
mi::bridge::IVideo_sink::video_frame()

Member Function Documentation

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

Returns the canvas that contains the decoded frame data.

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

The size of the encoded frame in bytes.

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

The decoding time in seconds.

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

The encoding time in seconds.

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

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