Member Functions

virtual void mi::​bridge::​IServer_video_context::close() [pure virtual]

Closes the video stream associated with this context and frees all resources. This will also close the associated video context on the client.

set_video_source(), mi::bridge::IClient_video_context

virtual void mi::​bridge::​IServer_video_context::frame_ready() [pure virtual]

Notifies the Bridge that the application produced the next video frame. When the process is ready to process the next frame it calls as response the callback mi::bridge::IVideo_source::video_get_next_frame() of the video source associated with this video context (see also set_video_source()).

This method can be called any number of times between callbacks, but multiple calls after the last video_get_next_frame() callback will only result in a single callback of video_get_next_frame().

virtual Uint32 mi::​bridge::​IServer_video_context::get_bit_rate() const [pure virtual]

Returns the currently used bit rate.

See also:

set_bit_rate()

virtual Uint32 mi::​bridge::​IServer_video_context::get_id() const [pure virtual]

Returns the ID of the video context.

virtual Uint32 mi::​bridge::​IServer_video_context::get_max_bitrate() const [pure virtual]

Returns the currently set maximum bitrate.

See also:

set_max_bitrate()

virtual Uint32 mi::​bridge::​IServer_video_context::get_max_frame_rate() const [pure virtual]

Returns the maximum frame rate.

See also:

set_max_frame_rate()

virtual Uint32 mi::​bridge::​IServer_video_context::get_min_bitrate() const [pure virtual]

Returns the currently set minimum bitrate.

See also:

set_min_bitrate()

virtual const IString* mi::​bridge::​IServer_video_context::get_video_format() const [pure virtual]

Returns the current video format for encoding.

See also:

set_video_format()

virtual IVideo_source* mi::​bridge::​IServer_video_context::get_video_source() const [pure virtual]

Returns the currently set video source, or NULL if none is set.

virtual void mi::​bridge::​IServer_video_context::report_error( Sint32 error_code, const char* error_message) [pure virtual]

Communicates an error message to the client side. The Bridge video protocol invokes IVideo_sink::video_error() on the video sink associated with the corresponding video context on the client side and passes the arguments provided here.

Parameters

error_code

Error code specified by the application.

error_message

A short description of the error.

virtual void mi::​bridge::​IServer_video_context::report_progress( Float64 value, const char* area, const char* message) [pure virtual]

Communicates a progress message to the client side. The Bridge video protocol invokes IVideo_sink::video_progress() on the video sink associated with the corresponding video context on the client side and passes the arguments provided here.

Parameters

value

The progress value.

area

The progress area.

message

The progress message.

virtual void mi::​bridge::​IServer_video_context::reset() [pure virtual]

Resets the video stream and any stateful video encoders like h264.

virtual Sint32 mi::​bridge::​IServer_video_context::set_bit_rate( Uint32 bit_rate) [pure virtual]

Sets the bit rate. This method is deprecated and is equivalent to calling set_max_bitrate() and set_min_bitrate() with the same value.

The "h264" format will use the frame rate and the current bit rate when calculating the budget for each frame. The quality of the "lossless" format and image formats is not affected by this setting.

Note:

It is recommended to change settings like video format, frame rate, and bit rate only from the mi::bridge::IVideo_source::video_get_next_frame() callback (or before the first call to frame_ready()). Otherwise, it is not guaranteed that multiple changes will be applied atomically to the next frame (because encoding of the next frame might start at any time).

See also:

get_bit_rate(), set_video_format(), set_max_frame_rate()

Parameters

bit_rate

The bit rate to use

Returns

0 in case of success, < 0 in case of failure.

virtual Sint32 mi::​bridge::​IServer_video_context::set_max_bitrate( Uint32 bit_rate) [pure virtual]

Sets the maximum bitrate used by the video stream. To adapt to the available bandwidth, the bridge video will automatically adjust the bitrate. However, the bitrate will not be set below the minimum bitrate. If the available bandwidth is smaller then frame rate will go down to compensate. Likewise, the bitrate won't go above the set maximum bitrate. Set min and max bitrate to the same value to override the automatic adjustment. The max bitrate setting takes precedence if max bitrate is set lower than min bitrate.

The "h264" format will use the frame rate and the current bit rate when calculating the budget for each frame. The quality of the "lossless" format and image formats is not affected by this setting.

Note:

It is recommended to change settings like video format, frame rate, and bit rate only from the mi::bridge::IVideo_source::video_get_next_frame() callback (or before the first call to frame_ready()). Otherwise, it is not guaranteed that multiple changes will be applied atomically to the next frame (because encoding of the next frame might start at any time).

See also:

get_max_bitrate(), set_min_bitrate(), get_bit_rate(), set_video_format(), set_max_frame_rate()

Parameters

bit_rate

The bit rate to use

Returns

0 in case of success, < 0 in case of failure.

virtual Sint32 mi::​bridge::​IServer_video_context::set_max_frame_rate( Uint32 frame_rate) [pure virtual]

Sets the maximum frame rate. This setting limits the rate at with which frames are sent from the server to this rate, but the frame rate is allowed to drop below this if frames are not produced or encoded quickly enough.

The "h264" format will use the frame rate and the current bit rate when calculating the budget for each frame. The quality of the "lossless" format and image formats is not affected by this setting.

Note:

It is recommended to change settings like video format, frame rate, and bit rate only from the mi::bridge::IVideo_source::video_get_next_frame() callback (or before the first call to frame_ready()). Otherwise, it is not guaranteed that multiple changes will be applied atomically to the next frame (because encoding of the next frame might start at any time).

See also:

get_max_frame_rate(), set_video_format(), set_bit_rate()

Parameters

frame_rate

The maximum frame rate to use.

Returns

0 in case of success, < 0 in case of failure.

virtual Sint32 mi::​bridge::​IServer_video_context::set_min_bitrate( Uint32 bit_rate) [pure virtual]

Sets the minimum bitrate used by the video stream. To adapt to the available bandwidth, the bridge video will automatically adjust the bitrate. is smaller then frame rate will go down to compensate. Likewise, the bitrate won't go above the set maximum bitrate. Set min and max bitrate to the same value to override the automatic adjustment. The max bitrate setting takes precedence if max bitrate is set lower than min bitrate.

The "h264" format will use the frame rate and the current bit rate when calculating the budget for each frame. The quality of the "lossless" format and image formats is not affected by this setting.

Note:

It is recommended to change settings like video format, frame rate, and bit rate only from the mi::bridge::IVideo_source::video_get_next_frame() callback (or before the first call to frame_ready()). Otherwise, it is not guaranteed that multiple changes will be applied atomically to the next frame (because encoding of the next frame might start at any time).

See also:

get_max_bitrate(), set_min_bitrate(), get_bit_rate(), set_video_format(), set_max_frame_rate()

Parameters

bit_rate

The bit rate to use

Returns

0 in case of success, < 0 in case of failure.

virtual Sint32 mi::​bridge::​IServer_video_context::set_render_frame_rate( Float64 frame_rate) [pure virtual]

Sets the current frame rate. This is an optional hint that can be set to inform the video context about the actual current frame rate. It is recommended to call this every time the actual frame rate changes substantially, or simply call in each mi::bridge::IVideo_source::video_get_next_frame() callback with the current value.

Note:

It is recommended to change settings like video format, frame rate, and bit rate only from the mi::bridge::IVideo_source::video_get_next_frame() callback (or before the first call to frame_ready()). Otherwise, it is not guaranteed that multiple changes will be applied atomically to the next frame (because encoding of the next frame might start at any time).

See also:

get_max_frame_rate(), set_video_format(), set_bit_rate()

Parameters

frame_rate

The maximum frame rate to use.

Returns

0 in case of success, < 0 in case of failure.

virtual Sint32 mi::​bridge::​IServer_video_context::set_video_format( const char* format) [pure virtual]

Sets the video format for encoding.

Note:

It is recommended to change settings like video format, frame rate, and bit rate only from the mi::bridge::IVideo_source::video_get_next_frame() callback (or before the first call to frame_ready()). Otherwise, it is not guaranteed that multiple changes will be applied atomically to the next frame (because encoding of the next frame might start at any time).

See also:

get_video_format(), set_max_frame_rate(), set_bit_rate()

Parameters

format

The video format to use when encoding canvases. Supported formats:

• "h264": h264 encoding, requires an h264 encoder plugin.
• "lossless": lossless encoding, supports all pixel formats, built-in.
• any valid image format: any supported image format, requires the corresponding image plugin.

Returns

• 0: Success.
• -1: Unsupported format.
• <= -2: Unspecified error.

virtual void mi::​bridge::​IServer_video_context::set_video_source( IVideo_source* video_source) [pure virtual]

Sets the video source that will produce video frames generated by the server.

Parameters

video_source

The video source to set. Replaces any previously set video source (if any). Pass NULL to disconnect the currently set video source.