LiteAVSDK
Tencent Cloud TRTC SDK, is a high availability components serving tens of thousands of enterprise customers, which is committed to helping you to minimize your research and development costs.
Namespaces | Data Structures | Macros
V2TXLiveDef

Namespaces

 liteav
 

Data Structures

struct  V2TXLiveVideoEncoderParam
 
struct  V2TXLiveVideoFrame
 
struct  V2TXLiveAudioFrame
 
struct  V2TXLiveAudioFrameObserverFormat
 
struct  V2TXLivePusherStatistics
 
struct  V2TXLivePlayerStatistics
 
struct  V2TXLiveLogConfig
 
struct  V2TXLiveImage
 
struct  V2TXLiveScreenCaptureSourceInfo
 
class  IV2TXLiveScreenCaptureSourceList
 
struct  V2TXLiveScreenCaptureProperty
 

Macros

#define LITEAV_API   __declspec(dllimport)
 
#define V2_API
 
#define TARGET_PLATFORM_DESKTOP   ((__APPLE__ && TARGET_OS_MAC && !TARGET_OS_IPHONE) || _WIN32)
 
#define TARGET_PLATFORM_PHONE   (__ANDROID__ || (__APPLE__ && TARGET_OS_IOS))
 

Detailed Description

Key type definitions for Tencent Cloud LVB.

Data Structure Documentation

◆ liteav::V2TXLiveVideoEncoderParam

struct liteav::V2TXLiveVideoEncoderParam

Video encoding parameters

These settings determine the quality of image viewed by remote users

Public Member Functions

 V2TXLiveVideoEncoderParam (V2TXLiveVideoResolution resolution)
 

Data Fields

V2TXLiveVideoResolution videoResolution
 
V2TXLiveVideoResolutionMode videoResolutionMode
 
uint32_t videoFps
 
uint32_t videoBitrate
 
uint32_t minVideoBitrate
 

Constructor & Destructor Documentation

◆ V2TXLiveVideoEncoderParam()

V2TXLiveVideoEncoderParam ( V2TXLiveVideoResolution  resolution)

Field Documentation

◆ minVideoBitrate

uint32_t minVideoBitrate

◆ videoBitrate

uint32_t videoBitrate

◆ videoFps

uint32_t videoFps

◆ videoResolution

V2TXLiveVideoResolution videoResolution

◆ videoResolutionMode

V2TXLiveVideoResolutionMode videoResolutionMode

◆ liteav::V2TXLiveVideoFrame

struct liteav::V2TXLiveVideoFrame

Video frame information V2TXLiveVideoFrame describes the raw data of a video image frame, which can be the image before frame encoding or the image after frame decoding.

Attention
Used during custom capture and rendering. During custom capture, you need to use TXLiveVideoFrame to contain the video frame to be sent. During custom rendering, the video frame contained by TXLiveVideoFrame will be returned.

Public Member Functions

 V2TXLiveVideoFrame ()
 

Data Fields

V2TXLivePixelFormat pixelFormat
 
V2TXLiveBufferType bufferType
 
char * data
 
int32_t length
 
int32_t width
 
int32_t height
 
V2TXLiveRotation rotation
 

Constructor & Destructor Documentation

◆ V2TXLiveVideoFrame()

V2TXLiveVideoFrame ( )
inline

Field Documentation

◆ bufferType

V2TXLiveBufferType bufferType

Field description: Video data container format.

◆ data

char* data

Field description: Video data when bufferType is V2TXLiveBufferTypePixelBuffer.

◆ height

int32_t height

Field description: Video height.

◆ length

int32_t length

Field description: Video length

◆ pixelFormat

V2TXLivePixelFormat pixelFormat

Field description: Video pixel format.

◆ rotation

V2TXLiveRotation rotation

Field description: Clockwise rotation angle of video frames.

◆ width

int32_t width

Field description: Video width

◆ liteav::V2TXLiveAudioFrame

struct liteav::V2TXLiveAudioFrame

audio frame

Public Member Functions

 V2TXLiveAudioFrame ()
 

Data Fields

char * data
 
uint32_t length
 
uint32_t sampleRate
 
uint32_t channel
 

Constructor & Destructor Documentation

◆ V2TXLiveAudioFrame()

V2TXLiveAudioFrame ( )
inline

Field Documentation

◆ channel

uint32_t channel

Field description: number of sound channels

◆ data

char* data

Field description: audio data

◆ length

uint32_t length

Field description: audio data length

◆ sampleRate

uint32_t sampleRate

Field description: audio sample rate

◆ liteav::V2TXLiveAudioFrameObserverFormat

struct liteav::V2TXLiveAudioFrameObserverFormat

audio frame format

Public Member Functions

 V2TXLiveAudioFrameObserverFormat ()
 

Data Fields

int sampleRate
 
int channel
 
int samplesPerCall
 

Constructor & Destructor Documentation

◆ V2TXLiveAudioFrameObserverFormat()

V2TXLiveAudioFrameObserverFormat ( )
inline

Field Documentation

◆ channel

int channel

◆ sampleRate

int sampleRate

◆ samplesPerCall

int samplesPerCall

◆ liteav::V2TXLivePusherStatistics

struct liteav::V2TXLivePusherStatistics

Pusher statistics.

Public Member Functions

 V2TXLivePusherStatistics ()
 

Data Fields

int32_t appCpu
 
int32_t systemCpu
 
int32_t width
 
int32_t height
 
int32_t fps
 
int32_t videoBitrate
 
int32_t audioBitrate
 

Constructor & Destructor Documentation

◆ V2TXLivePusherStatistics()

V2TXLivePusherStatistics ( )
inline

Field Documentation

◆ appCpu

int32_t appCpu

Field description: CPU utilization of the current app (%)

◆ audioBitrate

int32_t audioBitrate

Field description: Audio bitrate (Kbps)

◆ fps

int32_t fps

Field description: Frame rate (fps)

◆ height

int32_t height

Field description: Video height

◆ systemCpu

int32_t systemCpu

Field description: CPU utilization of the current system (%)

◆ videoBitrate

int32_t videoBitrate

Field description: Video bitrate (Kbps)

◆ width

int32_t width

Field description: Video width

◆ liteav::V2TXLivePlayerStatistics

struct liteav::V2TXLivePlayerStatistics

Player statistics.

Public Member Functions

 V2TXLivePlayerStatistics ()
 

Data Fields

int32_t appCpu
 
int32_t systemCpu
 
int32_t width
 
int32_t height
 
int32_t fps
 
int32_t videoBitrate
 
int32_t audioBitrate
 

Constructor & Destructor Documentation

◆ V2TXLivePlayerStatistics()

V2TXLivePlayerStatistics ( )
inline

Field Documentation

◆ appCpu

int32_t appCpu

Field description: CPU utilization of the current app (%)

◆ audioBitrate

int32_t audioBitrate

Field description: Audio bitrate (Kbps)

◆ fps

int32_t fps

Field description: Frame rate (fps)

◆ height

int32_t height

Field description: Video height

◆ systemCpu

int32_t systemCpu

Field description: CPU utilization of the current system (%)

◆ videoBitrate

int32_t videoBitrate

Field description: Video bitrate (Kbps)

◆ width

int32_t width

Field description: Video width

◆ liteav::V2TXLiveLogConfig

struct liteav::V2TXLiveLogConfig

Public Member Functions

 V2TXLiveLogConfig ()
 

Data Fields

V2TXLiveLogLevel logLevel
 
bool enableObserver
 
bool enableConsole
 
bool enableLogFile
 
const char * logPath
 

Constructor & Destructor Documentation

◆ V2TXLiveLogConfig()

V2TXLiveLogConfig ( )
inline

Field Documentation

◆ enableConsole

bool enableConsole

Field description: Whether to allow the SDK to print Log on the console of the editor (XCoder, Android Studio, Visual Studio, etc.) Recommended value: Default value: false

◆ enableLogFile

bool enableLogFile

Field description: Whether to enable local log file Special Instructions: If not for special needs, please do not close the local log file, otherwise the Tencent Cloud technical team will not be able to track and locate problems when they occur. Recommended value: Default value: true

◆ enableObserver

bool enableObserver

Field description: Whether to receive the log information to be printed through V2TXLivePremierObserver Special Instructions: If you want to implement Log writing by yourself, you can turn on this switch, Log information will be called back to you V2TXLivePremierObserver::onLog. Recommended value: Default value: false

◆ logLevel

V2TXLiveLogLevel logLevel

Field description: Set Log level Recommended value: Default value: V2TXLiveLogLevelAll

◆ logPath

const char* logPath

Field description: Set the storage directory of the local log, default Log storage location: Windows：appdata%/liteav/log

◆ liteav::V2TXLiveImage

struct liteav::V2TXLiveImage

Structure for storing window image infos.

Public Member Functions

 V2TXLiveImage ()
 

Data Fields

const char * imageSrc
 
V2TXLiveImageType imageType
 
uint32_t imageWidth
 
uint32_t imageHeight
 
uint32_t imageLength
 

Constructor & Destructor Documentation

◆ V2TXLiveImage()

V2TXLiveImage ( )
inline

Field Documentation

◆ imageHeight

uint32_t imageHeight

image height(ignore for V2TXLiveImageTypeFile)

◆ imageLength

uint32_t imageLength

image lenght in bytes

◆ imageSrc

const char* imageSrc

V2TXLiveImageTypeFile:imagePath,others:image content.

◆ imageType

V2TXLiveImageType imageType

image type

◆ imageWidth

uint32_t imageWidth

image width(ignore for V2TXLiveImageTypeFile)

◆ liteav::V2TXLiveScreenCaptureSourceInfo

struct liteav::V2TXLiveScreenCaptureSourceInfo

Screen sharing windows

You can call getScreenCaptureSources() to get a list of the sharable windows, which is returned via IV2TXLiveScreenCaptureSourceList.

Public Member Functions

 V2TXLiveScreenCaptureSourceInfo ()
 

Data Fields

V2TXLiveScreenCaptureSourceType sourceType
 
void * sourceId
 
const char * sourceName
 
V2TXLiveImage thumbBGRA
 
V2TXLiveImage iconBGRA
 
bool isMinimizeWindow
 
bool isMainScreen
 

Constructor & Destructor Documentation

◆ V2TXLiveScreenCaptureSourceInfo()

V2TXLiveScreenCaptureSourceInfo ( )
inline

Field Documentation

◆ iconBGRA

V2TXLiveImage iconBGRA

icon of the shared window

◆ isMainScreen

bool isMainScreen

Whether it is the main display (applicable to the case of multiple displays)

◆ isMinimizeWindow

bool isMinimizeWindow

is minimized window or not

◆ sourceId

void* sourceId

capturing source ID. For a window, this field indicates a window ID; for a screen, this field indicates a display ID.

◆ sourceName

const char* sourceName

capturing source name (encoded in UTF-8)

◆ sourceType

V2TXLiveScreenCaptureSourceType sourceType

capturing source type (i.e., whether to share the entire screen or a certain window)

◆ thumbBGRA

V2TXLiveImage thumbBGRA

thumbnail of the shared window

◆ liteav::IV2TXLiveScreenCaptureSourceList

class liteav::IV2TXLiveScreenCaptureSourceList

List of sharable screens and windows

Public Member Functions

virtual uint32_t getCount ()=0
 
virtual V2TXLiveScreenCaptureSourceInfo getSourceInfo (uint32_t index)=0
 
virtual void release ()=0
 

Protected Member Functions

virtual ~IV2TXLiveScreenCaptureSourceList ()
 

Constructor & Destructor Documentation

◆ ~IV2TXLiveScreenCaptureSourceList()

virtual ~IV2TXLiveScreenCaptureSourceList ( )
inlineprotectedvirtual

Member Function Documentation

◆ getCount()

virtual uint32_t getCount ( )
pure virtual
Returns
Size of this list.

◆ getSourceInfo()

virtual V2TXLiveScreenCaptureSourceInfo getSourceInfo ( uint32_t  index)
pure virtual
Returns
Get element(V2TXLiveScreenCaptureSourceInfo) by index.

◆ release()

virtual void release ( )
pure virtual

After traversing the list, call release to release the resources.

◆ liteav::V2TXLiveScreenCaptureProperty

struct liteav::V2TXLiveScreenCaptureProperty

Advanced control parameter of screen sharing

This parameter is used in the screen sharing-related API setScreenCaptureSource to set a series of advanced control parameters when specifying the sharing target. For example, whether to capture the cursor, whether to capture the subwindow, and whether to draw a frame around the shared target.

Public Member Functions

 V2TXLiveScreenCaptureProperty ()
 

Data Fields

bool enableCaptureMouse
 
bool enableHighlightBorder
 
bool enableHighPerformance
 
int highlightBorderColor
 
int highlightBorderSize
 
bool enableCaptureChildWindow
 

Constructor & Destructor Documentation

◆ V2TXLiveScreenCaptureProperty()

V2TXLiveScreenCaptureProperty ( )
inline

Field Documentation

◆ enableCaptureChildWindow

bool enableCaptureChildWindow

whether to capture the subwindow during window capturing (the subwindow and the captured window need to have an Owner or Popup attribute). Default value: false.

◆ enableCaptureMouse

bool enableCaptureMouse

whether to capture the cursor while capturing the target content. Default value: true.

◆ enableHighlightBorder

bool enableHighlightBorder

whether to highlight the window being shared (i.e., drawing a frame around the shared target). Default value: true.

◆ enableHighPerformance

bool enableHighPerformance

whether to enable the high performance mode (which will take effect only during screen sharing). Default value: true. Note: the screen capturing performance is the best after this mode is enabled, but the anti-blocking ability will be lost. If you enable enableHighlightBorder and enableHighPerformance at the same time, remote users will see the highlighted frame.

◆ highlightBorderColor

int highlightBorderColor

specify the color of the highlighted frame in RGB format. 0 indicates to use the default color of #8CBF26.

◆ highlightBorderSize

int highlightBorderSize

specify the width of the highlighted frame. 0 indicates to use the default width of 5 px. The maximum value you can set is 50.

Macro Definition Documentation

◆ LITEAV_API

#define LITEAV_API   __declspec(dllimport)

◆ TARGET_PLATFORM_DESKTOP

#define TARGET_PLATFORM_DESKTOP   ((__APPLE__ && TARGET_OS_MAC && !TARGET_OS_IPHONE) || _WIN32)

◆ TARGET_PLATFORM_PHONE

#define TARGET_PLATFORM_PHONE   (__ANDROID__ || (__APPLE__ && TARGET_OS_IOS))

◆ V2_API

#define V2_API