Namespace trtc

Classes

ITRTCCloud

Module: ITRTCCloud @ TXLiteAVSDK

SDK VERSION 6.0

Function: TRTC main API classes

Nouns[1]: primary stream - The channel for camera video is the primary stream.

Nouns[2]: substream - The channel for screen sharing or VOD play is the substream.

Nouns[3]: vodplay - TRTC for Windows allows the streaming of a local video file. This feature is known as VOD play.

Structs

RECT

Coordinates and size of the image. The coordinates (absolute pixel value) of the image’s top-left corner is (0,0).

TRTCAudioRecordingParams

Audio recording parameters

Description: the path you want to store the recording file in (required). You need to specify this parameter yourself and make sure that the path exits and is writable.

Note: The path must contain the filename and extension. The extension determines the format of the recording file. Supported formats include PCM, WAV, and AAC. For example, if you set this parameter to path/to/audio.aac, the recording file will be in AAC format. Please use a valid path that is readable and writable so that the recording file can be generated successfully.

TRTCLocalRecordingParams

Recording parameters

TRTCLocalStatistics

Local audio/video statistics

TRTCMixUser

5.10 Position of each image in On-Cloud MixTranscoding

You can use `TRTCMixUser` to specify the position of the video image of each stream (`userId`).

TRTCNetworkQosParam

6.3 QoS control parameters

QoS control parameters, which determine the SDK’s QoS policy under different network conditions, for example, whether to prioritize smoothness or clarity under poor network conditions

TRTCParams

6.1. Room entry parameters

You can call `enterRoom` to enter the specified room successfully only if you set the parameters as required.

TRTCPublishCDNParam

5.13 CDN relayed push parameters

TRTCQualityInfo

6.4 Video quality

You can use this parameter to display an icon on the UI that indicates the line quality of a user in a call.

TRTCRemoteStatistics

Audio/Video statistics of a remote user

TRTCRenderParams

5.3 Video rendering parameters

TRTCScreenCaptureSourceInfo

Screen sharing information

TRTCSpeedTestResult

6.8 Network speed testing result

Before room entry, you can use the `startSpeedTest` of `TRTCCloud` to test the network speed (do not call the API during a call). The result will be returned every 2-3 seconds, for one IP address at a time.

TRTCStatistics

Statistics

TRTCSwitchRoomConfig

Room switching parameters

TRTCTranscodingConfig

5.12 On-Cloud MixTranscoding parameters

The parameters determine the quality of encoded audio/video, the position of each image, etc.

TRTCVideoEncParam

6.2 Video encoding parameters

Encoding parameters determine the quality of video watched by remote users and recorded in the cloud.

TRTCVideoFrame

6.6 Video frame data

TRTCVolumeInfo

6.5 Volume

You can use this parameter to display an icon on the UI that indicates whether a user is speaking.

Interfaces

ITRTCCloudCallback

TRTC callback API class

ITRTCLogCallback

Log callbacks

ITRTCVideoRenderCallback

Custom video rendering callbacks

ITXMusicPlayObserver

Background music callbacks

Enums

TRTCAppScene

TRTCAudioFrameFormat

3.1 Audio frame format

TRTCAudioQuality

3.2 Audio quality

TRTCBeautyStyle

1.6 Beauty filter (skin smoothing) algorithm

TRTCDeviceState

5.2 Device operation

TRTCDeviceType

5.3 Device type

TRTCLocalRecordType

Local recording parameters

TRTCLogLevel

5.1 Log output level

TRTCMixInputType

2.6 Type of streams to mix

TRTCQosControlMode

2.3 QoS control mode

The TRTC SDK adjusts the codec and network module constantly to adapt to changing network conditions.

To support quick algorithm upgrade, the SDK provides two QoS control modes:

- ModeServer: cloud control, which is the default and recommended mode

- ModeClient: local control, which is for internal debugging of the SDK and is not recommended

TRTCQuality

1.4 Video quality

The TRTC SDK has defined 6 video quality standards. `Excellent` indicates the highest quality standard, and `Down` means the video is unavailable.

TRTCRoleType

2.2 Role (available only if TRTCAppScene is set to TRTCAppSceneLIVE or TRTCAppSceneVoiceChatRoom)

ln live streaming scenarios, the majority of users are audience and only a small number publish streams. Distinguishing them by giving each user a role allows TRTC to better optimize its features based on different roles.

- Anchor: Anchors can publish audio and video. Up to 50 users in a room can publish audio and video at the same time.

- Audience: Audience can play but cannot publish audio or video. There is no upper limit on the audience size in a room.

TRTCScreenCaptureSourceType

Type of the screen sharing source

You can call `getScreenCaptureSources()` to enumerate the shareable sources.

TRTCSnapshotSourceType

1.10 Video screenshot source

TRTCTranscodingConfigMode

5.11 Mixtranscoding configuration mode

TRTCVideoBufferType

1.9 Video data container format

TRTCVideoFillMode

1.5 Image fill mode

If the target resolution does not match the original resolution of a video, you need to specify the image fill mode.

- TRTCVideoFillMode_Fill: The excess parts are cropped, and the image may not be displayed in whole.

- TRTCVideoFillMode_Fit: The long side of the image is stretched to fit the screen, and the blank area is filled with black bars. The image is displayed in whole.

TRTCVideoMirrorType

1.9 Video mirror types

TRTCVideoPixelFormat

1.8 Video pixel format

The TRTC SDK allows custom video capturing and rendering. In custom video capturing, you can use the enumerated values below to specify the pixel format of the video you capture.

In custom video rendering, you can specify the pixel format of video data returned via the custom rendering callback.

TRTCVideoQosPreference

2.4 Video quality preference

You can specify whether to prioritize clarity or smoothness under poor network conditions.

- Smooth: prioritize smoothness under poor network conditions. The publishing and smooth playback of audio are prioritized. Video may be blurry and pixelated, but does not stutter.

- Clear: prioritize clarity under poor network conditions. Video is clear, but may stutter.

TRTCVideoResolution

1.1 Video resolution

TRTCVideoResolutionMode

1.2 Resolution mode

- Landscape resolution: TRTCVideoResolution_640_360 + TRTCVideoResolutionModeLandscape = 640 × 360

- Portrait resolution: TRTCVideoResolution_640_360 + TRTCVideoResolutionModePortrait = 360 × 640

TRTCVideoRotation

1.6 Image rotation

The TRTC SDK provides APIs for setting the rotation of local and remote videos.

TRTCVideoStreamType

1.3 Video stream type

There are three types of streams in TRTC, namely:

-Big-image stream: It is the most used stream type, which usually transfers video data captured by the camera.

-Small-image stream: It transfers the same data as the big-image stream, but at lower resolution and bitrate.

TRTCWaterMarkSrcType

TXAudioRoute

Audio route (for mobile devices only)

A mobile phone usually has two speakers. The audio route determines the speaker via which audio is played.

Speakerphone: speaker at the bottom of a phone, which plays audio at high volume and is used to play music out loud
Earpiece: receiver at the top of a phone, which plays audio at low volume and is suitable for calls

Call volume is designed for call scenarios. It uses phones’ built-in acoustic echo cancellation (AEC) technique and delivers lower audio quality than media volume. In the call volume mode, you cannot turn the volume to 0 using the volume buttons, but can use Bluetooth earphones for audio capturing.
Media volume is designed for music scenarios. It delivers better audio quality than call volume. In the media volume mode, if you enable AEC, the SDK will use its built-in algorithm to process audio. You can only use the phone’s mic, not Bluetooth earphones, for audio capturing.

The SDK provides three control modes for system volume types, including:

Auto: Call volume is used for anchors and co-anchoring users, and media volume for users not co-anchoring. This mode is suitable for live streaming scenarios. If you set the scenario to TRTCAppSceneLIVE or TRTCAppSceneVoiceChatRoom when calling enterRoom, the SDK will use this mode by default.
VOIP: Call volume is used throughout a call. This is suitable for conferencing scenarios. If you set the scenario to TRTCAppSceneVideoCall or TRTCAppSceneAudioCall when calling enterRoom, the SDK will use this mode by default.
Media: Media volume is used throughout a call. This mode is not used often, only under special circumstances such as when the anchor uses an external sound card.

TXVoiceChangeType

Voice changing effect

TXVoiceReverbType

Reverb effect