BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJSIP Reference

pj::VideoWindow Class Reference

#include <media.hpp>

Public Member Functions

 VideoWindow (int win_id)
 
VideoWindowInfo getInfo () const PJSUA2_THROW(Error)
 
VideoMedia getVideoMedia () PJSUA2_THROW(Error)
 
void Show (bool show) PJSUA2_THROW(Error)
 
void setPos (const MediaCoordinate &pos) PJSUA2_THROW(Error)
 
void setSize (const MediaSize &size) PJSUA2_THROW(Error)
 
void rotate (int angle) PJSUA2_THROW(Error)
 
void setWindow (const VideoWindowHandle &win) PJSUA2_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

Get window info.

Returns
video window info.

◆ getVideoMedia()

VideoMedia pj::VideoWindow::getVideoMedia ( )

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)

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
showSet to true to show the window, false to hide the window.

◆ setPos()

void pj::VideoWindow::setPos ( const MediaCoordinate pos)

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
posThe window position.

◆ setSize()

void pj::VideoWindow::setSize ( const MediaSize size)

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

Parameters
sizeThe new window size.

◆ rotate()

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

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
angleThe 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)

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
winThe new output window.

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

 


PJSIP Open Source, high performance, small footprint, and very very portable SIP stack
Copyright (C) 2006-2008 Teluu Inc.