ZDK::IVideoEndpointControl Class Reference

Video endpoint's main entry point. More...

#include <IVideoEndpointControl.h>

Inheritance diagram for ZDK::IVideoEndpointControl:

Public Member Functions
virtual ZDK::Shared::Result	SetFormat (int width, int height, float fps)=0
	Configures the used video format. More...
virtual ZDK::Shared::Result	SetBitrate (int value)=0
	Configures the video encoder's bitrate. More...
virtual ZDK::Shared::Result	StartCapture (bool hwdAcceleration)=0
	Starts the video capture. More...
virtual ZDK::Shared::Result	StopCapture ()=0
	Stops the video capture. More...
virtual ZDK::Shared::Result	ToggleCamera ()=0
	Toggles the camera. More...
virtual ZDK::Shared::Result	RestartCamera ()=0
	Restarts the camera. More...
virtual ZDK::CameraSensorLocation	GetCameraLocation () const =0
	Gets the used camera location. More...
Public Member Functions inherited from ZDK::IZHandle
virtual ZDK::ZDKHandle	Handle () const =0
virtual	operator ZDK::ZDKHandle () const =0
virtual void	Initialize ()=0
virtual void	ReleaseReference ()=0

Detailed Description

Video endpoint's main entry point.

Entry point for controlling the video endpoint

Member Function Documentation

GetCameraLocation()

virtual ZDK::CameraSensorLocation ZDK::IVideoEndpointControl::GetCameraLocation ( ) const

pure virtual

Gets the used camera location.

Not implemented!

Returns

The camera location

See also

CameraSensorLocation

RestartCamera()

virtual ZDK::Shared::Result ZDK::IVideoEndpointControl::RestartCamera ( )

pure virtual

Restarts the camera.

Not implemented!

Returns

Result of the invocation

See also

IResult

SetBitrate()

virtual ZDK::Shared::Result ZDK::IVideoEndpointControl::SetBitrate ( int  value )

pure virtual

Configures the video encoder's bitrate.

Configures the video encoder's output bitrate in bits per second. This function along with SetFormat() will affect all video calls. Because the frames come outside of this library if the frame rate is not as configured the resulting bit rate can differ greatly. Example: if the library's video encoder is configured for 128000 bps for a video format of 352x288 and 5 fps, but the frames actually come at 10fps the resulting bitrate will be 256000 bps.

Parameters

[in]

value

The bitrate of the encoder in bits per second

Returns

Result of the invocation

See also

IResult, SetFormat()

SetFormat()

virtual ZDK::Shared::Result ZDK::IVideoEndpointControl::SetFormat ( int  width, int  height, float  fps  )

pure virtual

Configures the used video format.

Configures the format used for negotiating video calls and actual camera capture/sending.

Most codecs have limitations regarding the frame dimensions. CIF formats are always supported.

When the format is negotiated with remote peer, the IVideoEventsHandler.OnVideoFormatSelected() callback will be called.

Parameters

[in]	width	Width of the video frame in pixels
[in]	height	Height of the video frame in pixels
[in]	fps	Frames per second of the video stream

Returns

Result of the invocation

See also

IResult, SetBitrate(), OnVideoFormatSelected()

StartCapture()

virtual ZDK::Shared::Result ZDK::IVideoEndpointControl::StartCapture ( bool  hwdAcceleration )

pure virtual

Starts the video capture.

Not implemented!

Parameters

[in]

hwdAcceleration

Indicator whether the hardware accelerator to be used if available

Returns

Result of the invocation

See also

IResult

StopCapture()

virtual ZDK::Shared::Result ZDK::IVideoEndpointControl::StopCapture ( )

pure virtual

Stops the video capture.

Not implemented!

Returns

Result of the invocation

See also

IResult

ToggleCamera()

virtual ZDK::Shared::Result ZDK::IVideoEndpointControl::ToggleCamera ( )

pure virtual

Toggles the camera.

Not implemented!

Returns

Result of the invocation

See also

IResult

---

The documentation for this class was generated from the following file:

• Controllers/IVideoEndpointControl.h