TeamTalk 4 C-API DLL
Version 4.6B
|
This section explains how to use the desktop sharing feature where users can share their desktop applications. More...
Classes | |
struct | DesktopWindow |
A struct containing the properties of a shared desktop window. More... | |
struct | DesktopInput |
A struct containing a mouse or keyboard event. More... | |
struct | ShareWindow |
A struct which describes the properties of a window which can be shared. More... | |
Macros | |
#define | TT_DESKTOPINPUT_MAX 16 |
#define | TT_DESKTOPINPUT_KEYCODE_IGNORE 0xFFFFFFFF |
#define | TT_DESKTOPINPUT_MOUSEPOS_IGNORE 0xFFFF |
#define | TT_DESKTOPINPUT_KEYCODE_LMOUSEBTN 0x1000 |
#define | TT_DESKTOPINPUT_KEYCODE_RMOUSEBTN 0x1001 |
#define | TT_DESKTOPINPUT_KEYCODE_MMOUSEBTN 0x1002 |
Typedefs | |
typedef enum BitmapFormat | BitmapFormat |
The bitmap format used for a DesktopWindow. More... | |
typedef enum DesktopProtocol | DesktopProtocol |
The protocols supported for transferring a DesktopWindow. More... | |
typedef struct DesktopWindow | DesktopWindow |
A struct containing the properties of a shared desktop window. More... | |
typedef enum DesktopKeyState | DesktopKeyState |
The state of a key (or mouse button), i.e. if it's pressed or released. More... | |
typedef UINT32 | DesktopKeyStates |
Mask of key states. More... | |
typedef struct DesktopInput | DesktopInput |
A struct containing a mouse or keyboard event. More... | |
typedef struct ShareWindow | ShareWindow |
A struct which describes the properties of a window which can be shared. More... | |
typedef enum TTKeyTranslate | TTKeyTranslate |
Translate to and from TeamTalk's intermediate key-codes (TTKEYCODE). More... | |
Enumerations | |
enum | BitmapFormat { BMP_NONE = 0, BMP_RGB8_PALETTE = 1, BMP_RGB16_555 = 2, BMP_RGB24 = 3, BMP_RGB32 = 4 } |
The bitmap format used for a DesktopWindow. More... | |
enum | DesktopProtocol { DESKTOPPROTOCOL_ZLIB_1 = 1 } |
The protocols supported for transferring a DesktopWindow. More... | |
enum | DesktopKeyState { DESKTOPKEYSTATE_NONE = 0x00000000, DESKTOPKEYSTATE_DOWN = 0x00000001, DESKTOPKEYSTATE_UP = 0x00000002 } |
The state of a key (or mouse button), i.e. if it's pressed or released. More... | |
enum | TTKeyTranslate { TTKEY_NO_TRANSLATE = 0, TTKEY_WINKEYCODE_TO_TTKEYCODE = 1, TTKEY_TTKEYCODE_TO_WINKEYCODE = 2, TTKEY_MACKEYCODE_TO_TTKEYCODE = 3, TTKEY_TTKEYCODE_TO_MACKEYCODE = 4 } |
Translate to and from TeamTalk's intermediate key-codes (TTKEYCODE). More... | |
Functions | |
TEAMTALKDLL_API INT32 | TT_SendDesktopWindow (IN TTInstance *lpTTInstance, IN const VOID *lpBitmap, IN INT32 nBitmapSize, IN const DesktopWindow *lpDesktopWindow, IN BitmapFormat nConvertBmpFormat) |
Transmit a desktop window (bitmap) to users in the same channel. More... | |
TEAMTALKDLL_API BOOL | TT_CloseDesktopWindow (IN TTInstance *lpTTInstance) |
Close the current desktop session. More... | |
TEAMTALKDLL_API unsigned char * | TT_Palette_GetColorTable (IN BitmapFormat nBmpPalette, IN INT32 nIndex) |
Get RGB values of the palette for the bitmap format. More... | |
TEAMTALKDLL_API HWND | TT_Windows_GetDesktopActiveHWND () |
Get the handle (HWND) of the window which is currently active (focused) on the Windows desktop. More... | |
TEAMTALKDLL_API HWND | TT_Windows_GetDesktopHWND () |
Get the handle (HWND) of the Windows desktop (full desktop). More... | |
TEAMTALKDLL_API BOOL | TT_Windows_GetDesktopWindowHWND (IN INT32 nIndex, OUT HWND *lpHWnd) |
Enumerate all the handles (HWND ) of visible windows. Increment nIndex until the function returns FALSE. Use TT_Windows_GetWindow() to get information about each window. More... | |
TEAMTALKDLL_API BOOL | TT_Windows_GetWindow (IN HWND hWnd, OUT ShareWindow *lpShareWindow) |
Get the properties of a window from its window handle (HWND). More... | |
TEAMTALKDLL_API INT32 | TT_SendDesktopWindowFromHWND (IN TTInstance *lpTTInstance, IN HWND hWnd, IN BitmapFormat nBitmapFormat, IN DesktopProtocol nDesktopProtocol) |
Transmit the specified window in a desktop session. More... | |
TEAMTALKDLL_API BOOL | TT_PaintDesktopWindow (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN HDC hDC, IN INT32 XDest, IN INT32 YDest, IN INT32 nDestWidth, IN INT32 nDestHeight) |
Paint user's desktop window using a Windows' DC (device context). More... | |
TEAMTALKDLL_API BOOL | TT_PaintDesktopWindowEx (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN HDC hDC, IN INT32 XDest, IN INT32 YDest, IN INT32 nDestWidth, IN INT32 nDestHeight, IN INT32 XSrc, IN INT32 YSrc, IN INT32 nSrcWidth, IN INT32 nSrcHeight) |
Paint user's desktop window using a Windows' DC (device context). More... | |
TEAMTALKDLL_API BOOL | TT_MacOS_GetWindow (IN INT32 nIndex, OUT ShareWindow *lpShareWindow) |
Enumerate all windows on the desktop. Increment nIndex until the function returns FALSE. Use TT_MacOS_GetWindowFromWindowID() to get information about the window, e.g. title, dimensions, etc. More... | |
TEAMTALKDLL_API BOOL | TT_MacOS_GetWindowFromWindowID (IN INT64 nWindowID, OUT ShareWindow *lpShareWindow) |
Get information about a window by passing its handle (CGWindowID ). More... | |
TEAMTALKDLL_API INT32 | TT_SendDesktopFromWindowID (IN TTInstance *lpTTInstance, IN INT64 nWindowID, IN BitmapFormat nBitmapFormat, IN DesktopProtocol nDesktopProtocol) |
Transmit the specified window in a desktop session. More... | |
TEAMTALKDLL_API BOOL | TT_SendDesktopCursorPosition (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN INT32 nPosX, IN INT32 nPosY) |
Send the position of mouse cursor to users in the same channel. More... | |
TEAMTALKDLL_API BOOL | TT_SendDesktopInput (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN const DesktopInput lpDesktopInputs[TT_DESKTOPINPUT_MAX], IN INT32 nDesktopInputCount) |
Send a mouse or keyboard event to a shared desktop window. More... | |
TEAMTALKDLL_API BOOL | TT_GetUserDesktopWindow (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN OUT VOID *lpBitmap, IN OUT INT32 *lpnBitmapSize, OUT DesktopWindow *lpDesktopWindow) |
Get a user's desktop window (bitmap image). More... | |
TEAMTALKDLL_API BOOL | TT_GetUserDesktopCursor (IN TTInstance *lpTTInstance, IN INT32 nSrcUserID, IN INT32 nDestUserID, OUT INT32 *lpnPosX, OUT INT32 *lpnPosY) |
Get the mouse cursor position of a user. More... | |
TEAMTALKDLL_API BOOL | TT_GetUserDesktopInput (IN TTInstance *lpTTInstance, IN INT32 nSrcUserID, OUT DesktopInput lpDesktopInputs[TT_DESKTOPINPUT_MAX], OUT INT32 *lpnDesktopInputCount) |
Get desktop (mouse or keyboard) input received from a user. More... | |
TEAMTALKDLL_API INT32 | TT_DesktopInput_KeyTranslate (TTKeyTranslate nTranslate, IN const DesktopInput *lpDesktopInputs, OUT DesktopInput *lpTranslatedDesktopInputs, IN INT32 nDesktopInputCount) |
Translate platform key-code to and from TeamTalk's intermediate format. More... | |
TEAMTALKDLL_API BOOL | TT_DesktopInput_Execute (IN const DesktopInput *lpDesktopInputs, IN INT32 nDesktopInputCount) |
Execute desktop (mouse or keyboard) input. More... | |
This section explains how to use the desktop sharing feature where users can share their desktop applications.
A user can transmit a desktop window to other users in a channel by passing the handle of a window to the TeamTalk client instance. The TeamTalk client then converts the window to a bitmap image which is transmitted to the server. The server then forwards the bitmap image to all other users in the channel.
Before sending a desktop window to a channel the handle (identifier) of the window to share must first be found. Windows, Mac and Linux (X11) have different ways of locating the window handle.
Instead of using a window handle it's also possible to simply send a raw bitmap by calling TT_SendDesktopWindow().
TeamTalk for Windows provides the following functions for obtaining different HWNDs:
HWND
of the window which has focus.HWND
of the Windows desktop.Once the HWND
of the window to share has been found use the following function for sending the window to the channel:
TeamTalk for Mac OS provides the following functions for obtaining desktop window handles:
Once the handle (CGWindowID
) of the window to share has been found use the following function for sending the window to the channel:
TeamTalk for Linux does not provide helper functions for getting the handle of a X11 window. This is in order to avoid linking the TeamTalk DLL to X11. Instead it is recommended to check out Qt Client Example (TeamTalk4) which shows how to convert X11 windows to bitmaps and use TT_SendDesktopWindow() for transmission.
When a shared desktop window is received the event WM_TEAMTALK_USER_DESKTOPWINDOW is posted to the local client instance. TT_GetUserDesktopWindow() can then be called to obtain a bitmap image of the shared window.
It is also possible to share the position of the mouse cursor when sharing a desktop window. Use TT_SendDesktopCursorPosition() to transmit the position of the mouse cursor. When the position is received the event WM_TEAMTALK_USER_DESKTOPCURSOR is posted to the local client instance. TT_GetUserDesktopCursor() can then be used to obtain the cursor position.
If a user has shared a desktop window it's possible for other users in the same channel to take over control of mouse and keyboard on the computer sharing the desktop window.
In order for a client instance to allow remote desktop access it is required to first subscribe to desktop input from the user who wants access to the shared desktop window. This is done by calling TT_DoSubscribe() along with the user-id and subscription SUBSCRIBE_DESKTOPINPUT. Once desktop input (mouse or keyboard input) is received from a remote user the WM_TEAMTALK_USER_DESKTOPINPUT event will be posted to the client instance. The actual mouse or keyboard input can then be obtained by the client instance using TT_GetUserDesktopInput() which returns a struct of type DesktopInput. Afterwards TT_DesktopInput_Execute() can be used to execute the mouse or keyboard input.
The remote user who wants to transmit mouse or keyboard input to the user sharing a desktop window can use TT_SendDesktopInput(). Remember that the user sharing the desktop window must have enabled the subscription SUBSCRIBE_DESKTOPINPUT.
It can be quite troublesome to handle keyboard input since each key-code depends on the OS and the regional settings on the OS. E.g. on a German keyboard the Z key is located where the Y key is on a US keyboard. The German keyboard also has letters which don't even appear on a US keyboard.
Because of the issues with keyboard layouts and regional settings the TeamTalk API provides TT_DesktopInput_KeyTranslate() which can be used to translate a keyboard's scan-code to an intermediate format. If e.g. a client instance is running Windows then TT_DesktopInput_KeyTranslate() can be called with TTKEY_WINKEYCODE_TO_TTKEYCODE which converts the scan-code on a Windows keyboard to TeamTalk's intermediate format (TTKEYCODE). To be able to execute the key-code once it's received it must be converted back again from TeamTalk's intermediate format to the platform where the application is running. I.e. if the TTKEYCODE is received on a Mac then TT_DesktopInput_KeyTranslate() must be called with TTKEY_TTKEYCODE_TO_MACKEYCODE.
When a key is pressed the OS generates a scan-code which denotes the location of the key on the keyboard. In order to generate the same key-press on a remote computer this scan-code must be converted to an intermediate format. The reason the scan-code cannot be sent directly is that the remote computer might use a different keyboard layout or run an operating system which has other values for the scan-codes.
The intermediate format for storing key-codes in TeamTalk is TTKEYCODE. Here's a table which shows how the keys on a US 104-keys keyboard are translated to TTKEYCODE.
Symbol | Shifted Symbol | Location | TTKEYCODE -------------------------------------------------- Esc | | | 0x0001 1 | ! | | 0x0002 2 | @ | | 0x0003 3 | # | | 0x0004 4 | $ | | 0x0005 5 | % | | 0x0006 6 | ^ | | 0x0007 7 | & | | 0x0008 8 | | | 0x0009 9 | ( | | 0x000a 0 | ) | | 0x000b - | _ | | 0x000c = | + | | 0x000d Backspace | | | 0x000e Tab | | | 0x000f Q | | | 0x0010 W | | | 0x0011 E | | | 0x0012 R | | | 0x0013 T | | | 0x0014 Y | | | 0x0015 U | | | 0x0016 I | | | 0x0017 O | | | 0x0018 P | | | 0x0019 [ | { | | 0x001a ] | } | | 0x001b Enter | | | 0x001c Ctrl | | Left | 0x001d A | | | 0x001e S | | | 0x001f D | | | 0x0020 F | | | 0x0021 G | | | 0x0022 H | | | 0x0023 J | | | 0x0024 K | | | 0x0025 L | | | 0x0026 ; | | | 0x0027 ' | | | 0x0028 ` | | | 0x0029 Shift | | Left | 0x002a \\ | | | | 0x002b Z | | | 0x002c X | | | 0x002d C | | | 0x002e V | | | 0x002f B | | | 0x0030 N | | | 0x0031 M | | | 0x0032 , | < | | 0x0033 . | > | | 0x0034 / | ? | | 0x0035 Shift | | Right | 0x0036 \* | | | 0x0037 Alt | | | 0x0038 Space bar | | | 0x0039 Caps Lock | | | 0x003a F1 | | | 0x003b F2 | | | 0x003c F3 | | | 0x003d F4 | | | 0x003e F5 | | | 0x003f F6 | | | 0x0040 F7 | | | 0x0041 F8 | | | 0x0042 F9 | | | 0x0043 Num Lock | | Numpad | 0x0044 Scroll Lock | | | 0x0046 Home | 7 | Numpad | 0x0047 Up arrow | 8 | Numpad | 0x0048 PgUp | 9 | Numpad | 0x0049 - | | Numpad | 0x004a Left arrow | 4 | Numpad | 0x004b 5 | | Numpad | 0x004c Right arrow | 6 | Numpad | 0x004d + | | Numpad | 0x004e End | 1 | Numpad | 0x004f Down arrow | 2 | Numpad | 0x0050 PgDn | 3 | Numpad | 0x0051 Insert | 0 | Numpad | 0x0052 Delete | | Numpad | 0x0053 F11 | | | 0x0057 F12 | | | 0x0058 Break | Pause | | 0x0100 Enter | | Numpad | 0x011c Ctrl | | Right | 0x011d / | | Numpad | 0x0135 SysRq | Print Scrn | | 0x0137 Alt | | Right | 0x0138 Home | | Funcpad | 0x0147 Up arrow | | Funcpad | 0x0148 Page Up | | Funcpad | 0x0149 Left arrow | | Funcpad | 0x014b Right arrow | | Funcpad | 0x014d End | | Funcpad | 0x014f Down arrow | | Funcpad | 0x0150 Page Down | | Funcpad | 0x0151 Insert | | Funcpad | 0x0152 Delete | | Funcpad | 0x0153 Windows | | Left | 0x015b Windows | | Right | 0x015c Menu | | | 0x015d | | | < | | Non-US | 0x0056 | | | Mouse btn | | Left | 0x1000 Mouse btn | | Right | 0x1001 Mouse btn | | Middle | 0x1002
#define TT_DESKTOPINPUT_MAX 16 |
The maximum number DesktopInput instances which can be sent by TT_SendDesktopInput() or received by TT_GetUserDesktopInput()
#define TT_DESKTOPINPUT_KEYCODE_IGNORE 0xFFFFFFFF |
If uKeyCode
in DesktopInput is set to TT_DESKTOPINPUT_KEYCODE_IGNORE it means no key (or mouse button) was pressed in the desktop input event and TT_DesktopInput_Execute() will ignore the value.
#define TT_DESKTOPINPUT_MOUSEPOS_IGNORE 0xFFFF |
If uMousePosX
or uMousePosY
in DesktopInput are set to TT_DESKTOPINPUT_MOUSEPOS_IGNORE it means the mouse position is ignored when calling TT_DesktopInput_Execute().
#define TT_DESKTOPINPUT_KEYCODE_LMOUSEBTN 0x1000 |
If uKeyCode
of DesktopInput is set to TT_DESKTOPINPUT_KEYCODE_LMOUSEBTN then TT_DesktopInput_Execute() will see the key-code as a left mouse button click.
#define TT_DESKTOPINPUT_KEYCODE_RMOUSEBTN 0x1001 |
If uKeyCode
of DesktopInput is set to TT_DESKTOPINPUT_KEYCODE_RMOUSEBTN then TT_DesktopInput_Execute() will see the key-code as a right mouse button click.
#define TT_DESKTOPINPUT_KEYCODE_MMOUSEBTN 0x1002 |
If uKeyCode
of DesktopInput is set to TT_DESKTOPINPUT_KEYCODE_MMOUSEBTN then TT_DesktopInput_Execute() will see the key-code as a middle mouse button click.
typedef enum BitmapFormat BitmapFormat |
The bitmap format used for a DesktopWindow.
typedef enum DesktopProtocol DesktopProtocol |
The protocols supported for transferring a DesktopWindow.
So far only one, UDP-based, protocol is supported.
typedef struct DesktopWindow DesktopWindow |
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().
typedef enum DesktopKeyState DesktopKeyState |
The state of a key (or mouse button), i.e. if it's pressed or released.
typedef UINT32 DesktopKeyStates |
Mask of key states.
typedef struct DesktopInput DesktopInput |
A struct containing a mouse or keyboard event.
The DesktopInput struct is used for desktop access where a remote user can control mouse or keybaord on a shared desktop. Check out section Remote Desktop Access on how to use remote desktop access.
typedef struct ShareWindow ShareWindow |
A struct which describes the properties of a window which can be shared.
typedef enum TTKeyTranslate TTKeyTranslate |
Translate to and from TeamTalk's intermediate key-codes (TTKEYCODE).
enum BitmapFormat |
The bitmap format used for a DesktopWindow.
Enumerator | |
---|---|
BMP_NONE |
Used to denote nothing selected. |
BMP_RGB8_PALETTE |
The bitmap is a 256-colored bitmap requiring a palette. The default 256 colored palette is the Netscape browser-safe palette. Use TT_Palette_GetColorTable() to access or change the palette. The maximum size of a 8-bit bitmap is 4095 blocks of 120 by 34 pixels. |
BMP_RGB16_555 |
The bitmap is a 16-bit colored bitmap. The maximum pixels. |
BMP_RGB24 |
The bitmap is a 24-bit colored bitmap. The maximum size of a 24-bit bitmap is 4095 blocks of 85 by 16 pixels. |
BMP_RGB32 |
The bitmap is a 32-bit colored bitmap. The maximum size of a 32-bit bitmap is 4095 blocks of 51 by 20 pixels. |
enum DesktopProtocol |
The protocols supported for transferring a DesktopWindow.
So far only one, UDP-based, protocol is supported.
Enumerator | |
---|---|
DESKTOPPROTOCOL_ZLIB_1 |
Desktop protocol based on ZLIB for image compression and UDP for data transmission. |
enum DesktopKeyState |
The state of a key (or mouse button), i.e. if it's pressed or released.
Enumerator | |
---|---|
DESKTOPKEYSTATE_NONE |
The key is ignored. |
DESKTOPKEYSTATE_DOWN |
The key is pressed. |
DESKTOPKEYSTATE_UP |
The key is released. |
enum TTKeyTranslate |
Translate to and from TeamTalk's intermediate key-codes (TTKEYCODE).
TEAMTALKDLL_API INT32 TT_SendDesktopWindow | ( | IN TTInstance * | lpTTInstance, |
IN const VOID * | lpBitmap, | ||
IN INT32 | nBitmapSize, | ||
IN const DesktopWindow * | lpDesktopWindow, | ||
IN BitmapFormat | nConvertBmpFormat | ||
) |
Transmit a desktop window (bitmap) to users in the same channel.
When TT_SendDesktopWindow() is called the first time a new desktop session will be started. To update the current desktop session call TT_SendDesktopWindow() again once the previous desktop transmission has finished. Tracking progress of the current desktop transmission is done by checking for the WM_TEAMTALK_DESKTOPWINDOW_TRANSFER event. While the desktop transmission is active the flag CLIENT_TX_DESKTOP will be set on the local client instance.
If the desktop window (bitmap) changes size (width/height) or format a new desktop session will be started. Also if the user changes channel a new desktop session will be started. Check nSessionID
of DesktopWindow to see if a new desktop session is started or the WM_TEAMTALK_USER_DESKTOPWINDOW event.
Remote users will get the WM_TEAMTALK_USER_DESKTOPWINDOW event and can call TT_GetUserDesktopWindow() to retrieve the desktop window.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
lpBitmap | Pointer to bitmap buffer. |
nBitmapSize | Size of bitmap buffer lpBitmap in bytes. The size of the bitmap can be calculated using the DesktopWindow-struct's nBytesPerLine multiplied by the nHeight . |
lpDesktopWindow | Properties of the bitmap. Set the nSessionID property to 0. |
nConvertBmpFormat | Before transmission convert the bitmap to this format. |
nBitmapSize
is invalid or if a desktop transmission is already active. TEAMTALKDLL_API BOOL TT_CloseDesktopWindow | ( | IN TTInstance * | lpTTInstance | ) |
Close the current desktop session.
Closing the desktop session will cause the users receiving the current desktop session to see the desktop session ID change to 0 in the WM_TEAMTALK_USER_DESKTOPWINDOW event.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
TEAMTALKDLL_API unsigned char* TT_Palette_GetColorTable | ( | IN BitmapFormat | nBmpPalette, |
IN INT32 | nIndex | ||
) |
Get RGB values of the palette for the bitmap format.
This currently only applies to bitmaps of format BMP_RGB8_PALETTE.
Note that the pointer returned is non-const which means the palette can be overwritten with a custom palette. The custom palette will then be used internally during bitmap conversion.
nBmpPalette | The bitmap format. Currently only BMP_RGB8_PALETTE is supported. |
nIndex | The index in the color table of the RGB values to extract. |
TEAMTALKDLL_API HWND TT_Windows_GetDesktopActiveHWND | ( | ) |
Get the handle (HWND) of the window which is currently active (focused) on the Windows desktop.
TEAMTALKDLL_API HWND TT_Windows_GetDesktopHWND | ( | ) |
Get the handle (HWND) of the Windows desktop (full desktop).
TEAMTALKDLL_API BOOL TT_Windows_GetDesktopWindowHWND | ( | IN INT32 | nIndex, |
OUT HWND * | lpHWnd | ||
) |
Enumerate all the handles (HWND
) of visible windows. Increment nIndex
until the function returns FALSE. Use TT_Windows_GetWindow() to get information about each window.
TEAMTALKDLL_API BOOL TT_Windows_GetWindow | ( | IN HWND | hWnd, |
OUT ShareWindow * | lpShareWindow | ||
) |
Get the properties of a window from its window handle (HWND).
TEAMTALKDLL_API INT32 TT_SendDesktopWindowFromHWND | ( | IN TTInstance * | lpTTInstance, |
IN HWND | hWnd, | ||
IN BitmapFormat | nBitmapFormat, | ||
IN DesktopProtocol | nDesktopProtocol | ||
) |
Transmit the specified window in a desktop session.
Same as TT_SendDesktopWindow() except the properties for the DesktopWindow are extracted automatically.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
hWnd | Windows handle for the window to transmit. |
nBitmapFormat | Bitmap format to use for the transmitted image. |
nDesktopProtocol | The protocol to use for transmitting the image. |
TEAMTALKDLL_API BOOL TT_PaintDesktopWindow | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN HDC | hDC, | ||
IN INT32 | XDest, | ||
IN INT32 | YDest, | ||
IN INT32 | nDestWidth, | ||
IN INT32 | nDestHeight | ||
) |
Paint user's desktop window using a Windows' DC (device context).
Same as calling TT_PaintDesktopWindowEx() like this:
TT_PaintDesktopWindowEx(lpTTInstance, nUserID, hDC, XDest, YDest, nDestWidth, nDestHeight, 0, 0, 'src_bmp_width', 'src_bmp_height');
src_bmp_width
and src_bmp_height
are extracted internally from the source image.
TEAMTALKDLL_API BOOL TT_PaintDesktopWindowEx | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN HDC | hDC, | ||
IN INT32 | XDest, | ||
IN INT32 | YDest, | ||
IN INT32 | nDestWidth, | ||
IN INT32 | nDestHeight, | ||
IN INT32 | XSrc, | ||
IN INT32 | YSrc, | ||
IN INT32 | nSrcWidth, | ||
IN INT32 | nSrcHeight | ||
) |
Paint user's desktop window using a Windows' DC (device context).
An application can either paint a bitmap by using TT_GetUserDesktopWindow() which provides a pointer to a bitmap or the application can ask the client instance to paint the image using this function.
Typically this paint operation will be called in the WM_PAINT message. Here is how the client instance paints internally:
StretchDIBits(hDC, nPosX, nPosY, nWidth, nHeight, XSrc, YSrc, nSrcWidth, nSrcHeight, frame_buf, &bmi, DIB_RGB_COLORS, SRCCOPY);
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | The user's ID. |
hDC | The handle to the Windows device context. |
XDest | Coordinate of left corner where to start painting. |
YDest | Coordinate or top corner where to start painting. |
nDestWidth | The width of the image. |
nDestHeight | The height of the image. |
XSrc | The left coordinate in the source bitmap of where to start reading. |
YSrc | The top left coordinate in the source bitmap of where to start reading. |
nSrcWidth | The number of width pixels to read from source bitmap. |
nSrcHeight | The number of height pixels to read from source bitmap. |
TEAMTALKDLL_API BOOL TT_MacOS_GetWindow | ( | IN INT32 | nIndex, |
OUT ShareWindow * | lpShareWindow | ||
) |
Enumerate all windows on the desktop. Increment nIndex
until the function returns FALSE. Use TT_MacOS_GetWindowFromWindowID() to get information about the window, e.g. title, dimensions, etc.
TEAMTALKDLL_API BOOL TT_MacOS_GetWindowFromWindowID | ( | IN INT64 | nWindowID, |
OUT ShareWindow * | lpShareWindow | ||
) |
Get information about a window by passing its handle (CGWindowID
).
TEAMTALKDLL_API INT32 TT_SendDesktopFromWindowID | ( | IN TTInstance * | lpTTInstance, |
IN INT64 | nWindowID, | ||
IN BitmapFormat | nBitmapFormat, | ||
IN DesktopProtocol | nDesktopProtocol | ||
) |
Transmit the specified window in a desktop session.
Same as TT_SendDesktopWindow() except the properties for the DesktopWindow are extracted automatically.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nWindowID | The handle of the window which should be converted to bitmap and sent to the server. |
nBitmapFormat | Bitmap format to use for the transmitted image. |
nDesktopProtocol | The protocol to use for transmitting the image. |
TEAMTALKDLL_API BOOL TT_SendDesktopCursorPosition | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN INT32 | nPosX, | ||
IN INT32 | nPosY | ||
) |
Send the position of mouse cursor to users in the same channel.
It's only possible to send the mouse cursor position if there's a desktop session which is currently active.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | For now set to 0. |
nPosX | X coordinate of mouse cursor. Max is 65535. |
nPosY | Y coordinate of mouse cursor. Max is 65535. |
TEAMTALKDLL_API BOOL TT_SendDesktopInput | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN const DesktopInput | lpDesktopInputs[TT_DESKTOPINPUT_MAX], | ||
IN INT32 | nDesktopInputCount | ||
) |
Send a mouse or keyboard event to a shared desktop window.
If a user is sharing a desktop window it's possible for a remote user to take control of mouse and keyboard input on the remote computer. Read section Transmit Desktop Input on how to transmit desktop input to a shared window.
When the remote user receives the issued DesktopInput the event WM_TEAMTALK_USER_DESKTOPINPUT is posted to the client instance sharing the desktop window and TT_GetUserDesktopInput() can be used to retrieve the transmitted DesktopInput structs.
Requires TeamTalk v. 4.6+ client and server.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | The user's ID who owns the shared desktop window and should receive desktop input. |
lpDesktopInputs | An array of DesktopInput structs which should be transmitted to the user. Internally in the client instance each user ID has an internal queue which can contain a maximum of 100 DesktopInput structs. |
nDesktopInputCount | Must be less or equal to TT_DESKTOPINPUT_MAX. |
nUserID
doesn't subscribe to desktop input. TEAMTALKDLL_API BOOL TT_GetUserDesktopWindow | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN OUT VOID * | lpBitmap, | ||
IN OUT INT32 * | lpnBitmapSize, | ||
OUT DesktopWindow * | lpDesktopWindow | ||
) |
Get a user's desktop window (bitmap image).
A user's desktop window can be extracted when the WM_TEAMTALK_USER_DESKTOPWINDOW is received.
A desktop window is simply a bitmap image. This method is used for copying the user's bitmap image to a pre-allocated buffer.
To know the properties of the bitmap call this method with lpBitmap
set to NULL and extract the properties in lpDesktopWindow
. The size of the buffer to allocate will be nBytesPerLine
multiplied by nHeight
in the DesktopWindow.
For BMP_RGB8_PALETTE bitmaps check out TT_Palette_GetColorTable().
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | The user's ID. |
lpBitmap | Pointer to a pre-allocated buffer where the bitmap data will be copied to. Pass NULL to query the byte size of the bitmap, so it can be written to lpnBitmapSize and lpDesktopWindow . |
lpnBitmapSize | Size of the allocated bitmap buffer lpBitmap . If lpBitmap is NULL the size of the bitmap will be written to this parameter. |
lpDesktopWindow | The properties of the shared desktop window. Pass NULL to lpBitmap to query the properties of the desktop window. |
TEAMTALKDLL_API BOOL TT_GetUserDesktopCursor | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nSrcUserID, | ||
IN INT32 | nDestUserID, | ||
OUT INT32 * | lpnPosX, | ||
OUT INT32 * | lpnPosY | ||
) |
Get the mouse cursor position of a user.
The mouse cursor position will be available when the WM_TEAMTALK_USER_DESKTOPCURSOR is received and there's an active desktop session.
A mouse cursor position is transmitted using TT_SendDesktopCursorPosition().
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nSrcUserID | The owner of the cursor. |
nDestUserID | The owner of the desktop session where the cursor is pointing to. |
lpnPosX | Output parameter for X coordinate. |
lpnPosY | Output parameter for Y coordinate. |
lpnPosX
and lpnPosY
. TEAMTALKDLL_API BOOL TT_GetUserDesktopInput | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nSrcUserID, | ||
OUT DesktopInput | lpDesktopInputs[TT_DESKTOPINPUT_MAX], | ||
OUT INT32 * | lpnDesktopInputCount | ||
) |
Get desktop (mouse or keyboard) input received from a user.
Desktop input is used in combination with a shared desktop window, see Desktop Sharing.
If the local client instance is subscribing to desktop input (i.e. SUBSCRIBE_DESKTOPINPUT) then a remote user can send desktop input to the local client instance. Once the client instance receives desktop input it posts the message WM_TEAMTALK_USER_DESKTOPINPUT and TT_GetUserDesktopInput() can be used to obtain the DesktopInput structs send by the remote user. See Receive Desktop Input for more information on receiving desktop input.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nSrcUserID | The user's ID who sent desktop input, see WM_TEAMTALK_USER_DESKTOPINPUT. |
lpDesktopInputs | A pre-allocated array which will receive the DesktopInput stucts. |
lpnDesktopInputCount | The number of DesktopInput structs written to lpDesktopInputs . |
TEAMTALKDLL_API INT32 TT_DesktopInput_KeyTranslate | ( | TTKeyTranslate | nTranslate, |
IN const DesktopInput * | lpDesktopInputs, | ||
OUT DesktopInput * | lpTranslatedDesktopInputs, | ||
IN INT32 | nDesktopInputCount | ||
) |
Translate platform key-code to and from TeamTalk's intermediate format.
Section Translation of key-codes to TTKEYCODE-format. has a table which shows how the keys on a US 104-keyboard are translated to TeamTalk's intermediate format.
Section Desktop Input and Keyboard Layouts explains how to transmit key-codes.
nTranslate | The key-code format to translate to and from. |
lpDesktopInputs | An array of DesktopInput structs to translate. |
lpTranslatedDesktopInputs | A pre-allocated array of DesktopInput struct to hold the translated desktop input. |
nDesktopInputCount | The number of elements to translate in lpDesktopInputs . |
nDesktopInputCount
then some uKeyCode
values could not be translated and have been assigned the value TT_DESKTOPINPUT_KEYCODE_IGNORE. TEAMTALKDLL_API BOOL TT_DesktopInput_Execute | ( | IN const DesktopInput * | lpDesktopInputs, |
IN INT32 | nDesktopInputCount | ||
) |
Execute desktop (mouse or keyboard) input.
When executed either a key-press, key-release or mouse move will take place on the computer running the client instance. Remember to calculate the offsets for the mouse cursor prior to this call. The mouse position will be relative to the screen resolution.
The content of the DesktopInput struct must been translated to the platform's key-code format prior to this call. I.e. uKeyCode must be a either a Windows scan-code, Mac OS X Carbon key-code or one of the mouse buttons: TT_DESKTOPINPUT_KEYCODE_LMOUSEBTN, TT_DESKTOPINPUT_KEYCODE_RMOUSEBTN, TT_DESKTOPINPUT_KEYCODE_MMOUSEBTN.
lpDesktopInputs | The mouse or keyboard inputs. |
nDesktopInputCount | The number of elements in lpDesktopInputs . |