TeamTalk 4 C-API DLL  Version 4.5A
DesktopWindow Struct Reference

A struct containing the properties of a shared desktop window. More...

#include <TeamTalk4.h>

Public Attributes

INT32 nWidth
 The width in pixels of the bitmap. More...
 
INT32 nHeight
 The height in pixels of the bitmap. More...
 
BitmapFormat bmpFormat
 The format of the bitmap. More...
 
INT32 nBytesPerLine
 The number of bytes for each scan-line in the bitmap. Zero means 4-byte aligned. More...
 
INT32 nSessionID
 The ID of the session which the bitmap belongs to. If the session ID changes it means the user has started a new session. This e.g. happens if the desktop session has been closed and restart or if the bitmap has been resized. Set nSessionID to 0 if the desktop window is used with TT_SendDesktopWindow(). More...
 
DesktopProtocol nProtocol
 The desktop protocol used for transmitting the desktop window. More...
 

Detailed Description

A struct containing the properties of a shared desktop window.

The desktop window is a description of the bitmap which can be retrieved using TT_GetUserDesktopWindow() or the bitmap which should be transmitted using TT_SendDesktopWindow().

Member Data Documentation

INT32 DesktopWindow::nWidth

The width in pixels of the bitmap.

INT32 DesktopWindow::nHeight

The height in pixels of the bitmap.

BitmapFormat DesktopWindow::bmpFormat

The format of the bitmap.

INT32 DesktopWindow::nBytesPerLine

The number of bytes for each scan-line in the bitmap. Zero means 4-byte aligned.

INT32 DesktopWindow::nSessionID

The ID of the session which the bitmap belongs to. If the session ID changes it means the user has started a new session. This e.g. happens if the desktop session has been closed and restart or if the bitmap has been resized. Set nSessionID to 0 if the desktop window is used with TT_SendDesktopWindow().

DesktopProtocol DesktopWindow::nProtocol

The desktop protocol used for transmitting the desktop window.