neuray API Programmer's Manual

mi::bridge::IVideo_frame Class Reference

[Bridge client]

Description

Represents the data for a single video frame.

See also:

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

Public Member Functions

virtual neuraylib::​ICanvasget_canvas() const =0
Returns the canvas that contains the decoded frame data.
virtual Size get_compressed_size() const =0
The size of the encoded frame in bytes.
virtual Float32 get_decode_time() const =0
The decoding time in seconds.
virtual Float32 get_encode_time() const =0
The encoding time in seconds.
virtual const char* get_video_format() const =0
The video format used when encoding this frame on the server.
virtual IDataget_video_format_attribute( const char* attribute) const =0
Returns a video format attribute by name. More...

Member Functions

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.

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