TeamTalk 5 Java DLL: BearWare.DesktopWindow Struct Reference

TeamTalk 5 Java DLL Version 5.18A

Loading...
Searching...
No Matches
Public Attributes | List of all members
BearWare.DesktopWindow Struct Reference
Desktop Sharing

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

## Public Attributes

int | nWidth
| The width in pixels of the bitmap.
int | nHeight
| The height in pixels of the bitmap.
BitmapFormat | bmpFormat
| The format of the bitmap.
int | nBytesPerLine
| The number of bytes for each scan-line in the bitmap. Zero means 4-byte aligned.
int | 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 TeamTalkBase.SendDesktopWindow().

DesktopProtocol | nProtocol
| The desktop protocol used for transmitting the desktop window.
IntPtr | frameBuffer
| A buffer pointing to the bitmap data (often refered to as Scan0).
int | nFrameBufferSize
| The size in bytes of the buffer allocate in frameBuffer. Typically `nBytesPerLine` * `nHeight`.

## 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 TeamTalkBase.AcquireUserDesktopWindow() or the bitmap which should be transmitted using TeamTalkBase.SendDesktopWindow().

Definition at line 765 of file TeamTalk.cs.

## Member Data Documentation

## ◆ nWidth

int BearWare.DesktopWindow.nWidth

The width in pixels of the bitmap.

Definition at line 768 of file TeamTalk.cs.

## ◆ nHeight

int BearWare.DesktopWindow.nHeight

The height in pixels of the bitmap.

Definition at line 770 of file TeamTalk.cs.

## ◆ bmpFormat

BitmapFormat BearWare.DesktopWindow.bmpFormat

The format of the bitmap.

Definition at line 772 of file TeamTalk.cs.

## ◆ nBytesPerLine

int BearWare.DesktopWindow.nBytesPerLine

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

Definition at line 775 of file TeamTalk.cs.

## ◆ nSessionID

int BearWare.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 TeamTalkBase.SendDesktopWindow().

Definition at line 782 of file TeamTalk.cs.

## ◆ nProtocol

DesktopProtocol BearWare.DesktopWindow.nProtocol

The desktop protocol used for transmitting the desktop window.

Definition at line 784 of file TeamTalk.cs.

## ◆ frameBuffer

IntPtr BearWare.DesktopWindow.frameBuffer

A buffer pointing to the bitmap data (often refered to as Scan0).

Definition at line 786 of file TeamTalk.cs.

## ◆ nFrameBufferSize

int BearWare.DesktopWindow.nFrameBufferSize

The size in bytes of the buffer allocate in frameBuffer. Typically `nBytesPerLine` * `nHeight`.

Definition at line 789 of file TeamTalk.cs.