pj::VideoWindow Class Reference

#include <media.hpp>

Public Member Functions
	VideoWindow (int win_id)
VideoWindowInfo	getInfo () const throw (Error)
VideoMedia	getVideoMedia () throw (Error)
void	Show (bool show) throw (Error)
void	setPos (const MediaCoordinate &pos) throw (Error)
void	setSize (const MediaSize &size) throw (Error)
void	rotate (int angle) throw (Error)
void	setWindow (const VideoWindowHandle &win) throw (Error)
void	setFullScreen (bool enabled) throw (Error)
void	setFullScreen2 (pjmedia_vid_dev_fullscreen_flag mode) throw (Error)

Detailed Description

Video window.

Constructor & Destructor Documentation

VideoWindow()

pj::VideoWindow::VideoWindow

(

int

win_id

)

Constructor

Member Function Documentation

getInfo()

VideoWindowInfo pj::VideoWindow::getInfo	(		)	const
throw	(	Error
	)

Get window info.

Returns

video window info.

getVideoMedia()

VideoMedia pj::VideoWindow::getVideoMedia	(		)
throw	(	Error
	)

Get video media or conference bridge port of the renderer of this video window.

Returns

Video media of this renderer window.

Show()

void pj::VideoWindow::Show	(	bool	show	)
throw	(	Error
	)

Show or hide window. This operation is not valid for native windows (VideoWindowInfo.isNative=true), on which native windowing API must be used instead.

Parameters

show	Set to true to show the window, false to hide the window.

setPos()

void pj::VideoWindow::setPos	(	const MediaCoordinate &	pos	)
throw	(	Error
	)

Set video window position. This operation is not valid for native windows (VideoWindowInfo.isNative=true), on which native windowing API must be used instead.

Parameters

pos	The window position.

setSize()

void pj::VideoWindow::setSize	(	const MediaSize &	size	)
throw	(	Error
	)

Resize window. This operation is not valid for native windows (VideoWindowInfo.isNative=true), on which native windowing API must be used instead.

Parameters

size	The new window size.

rotate()

void pj::VideoWindow::rotate	(	int	angle	)
throw	(	Error
	)

Rotate the video window. This function will change the video orientation and also possibly the video window size (width and height get swapped). This operation is not valid for native windows (VideoWindowInfo.isNative =true), on which native windowing API must be used instead.

Parameters

angle

The rotation angle in degrees, must be multiple of 90. Specify positive value for clockwise rotation or negative value for counter-clockwise rotation.

setWindow()

void pj::VideoWindow::setWindow	(	const VideoWindowHandle &	win	)
throw	(	Error
	)

Set output window. This operation is valid only when the underlying video device supports PJMEDIA_VIDEO_DEV_CAP_OUTPUT_WINDOW capability AND allows the output window to be changed on-the-fly, otherwise Error will be thrown. Currently it is only supported on Android.

Parameters

win	The new output window.

setFullScreen()

void pj::VideoWindow::setFullScreen	(	bool	enabled	)
throw	(	Error
	)

Set video window full-screen. This operation is valid only when the underlying video device supports PJMEDIA_VID_DEV_CAP_OUTPUT_FULLSCREEN capability. Currently it is only supported on SDL backend.

Parameters

enabled

Set to true if full screen is desired, false otherwise.

setFullScreen2()

void pj::VideoWindow::setFullScreen2	(	pjmedia_vid_dev_fullscreen_flag	mode	)
throw	(	Error
	)

Set video window full-screen. This operation is valid only when the underlying video device supports PJMEDIA_VID_DEV_CAP_OUTPUT_FULLSCREEN capability. Currently it is only supported on SDL backend.

Parameters

mode	Fullscreen mode, see pjmedia_vid_dev_fullscreen_flag.

---

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

• media.hpp