TeamTalk 5 C-API DLL: VideoFrame Struct Reference

TeamTalk 5 C-API DLL Version 5.18A

Loading...
Searching...
No Matches
Public Attributes | List of all members
VideoFrame Struct Reference
Video Capture and Image Display

A RGB32 image where the pixels can be accessed directly in an allocated frameBuffer. More...

`#include <TeamTalk.h>`

## Public Attributes

INT32 | nWidth
| The width in pixels of the image contained in frameBuffer.
INT32 | nHeight
| The height in pixels of the image contained in imageBuffer.
INT32 | nStreamID

A unique identifier for the frames which are part of the same video sequence. If the stream ID changes it means the frames which are being received are part of a new video sequence and nWidth and nHeight may have changed. The nStreamID will always be a positive integer value.

TTBOOL | bKeyFrame
| Whether the image acquired is a key-frame. If it is not a key-frame and there has been packet loss or a key-frame has not been acquired prior then the image may look blurred.
VOID * | frameBuffer
| A buffer allocated internally by client instance.
INT32 | nFrameBufferSize
| The size in bytes of the buffer allocate in frameBuffer.

## Detailed Description

A RGB32 image where the pixels can be accessed directly in an allocated frameBuffer.

Use TT_AcquireUserVideoCaptureFrame() to acquire a user's image and remember to call TT_ReleaseUserVideoCaptureFrame() when the image has been processed so TeamTalk can release its resources.

Definition at line 866 of file TeamTalk.h.

## Member Data Documentation

## ◆ nWidth

INT32 VideoFrame::nWidth

The width in pixels of the image contained in frameBuffer.

Definition at line 870 of file TeamTalk.h.

## ◆ nHeight

INT32 VideoFrame::nHeight

The height in pixels of the image contained in imageBuffer.

Definition at line 873 of file TeamTalk.h.

## ◆ nStreamID

INT32 VideoFrame::nStreamID

A unique identifier for the frames which are part of the same video sequence. If the stream ID changes it means the frames which are being received are part of a new video sequence and nWidth and nHeight may have changed. The nStreamID will always be a positive integer value.

Definition at line 879 of file TeamTalk.h.

## ◆ bKeyFrame

TTBOOL VideoFrame::bKeyFrame

Whether the image acquired is a key-frame. If it is not a key-frame and there has been packet loss or a key-frame has not been acquired prior then the image may look blurred.

Definition at line 884 of file TeamTalk.h.

## ◆ frameBuffer

VOID* VideoFrame::frameBuffer

A buffer allocated internally by client instance.

Definition at line 886 of file TeamTalk.h.

## ◆ nFrameBufferSize

INT32 VideoFrame::nFrameBufferSize

The size in bytes of the buffer allocate in frameBuffer.

Definition at line 889 of file TeamTalk.h.