Tencent RTC

https://trtc.io/zh/document/
Admin
Tencent RTC is a real-time communication platform that enables developers to build conversational...
Tokens:3,662,031
Snippets:38,158
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Web Recording Task Response

Source: https://trtc.io/zh/document/72066?menulabel=core+sdk&platform=android&product=rtcengine

Example JSON response returned by the server after a successful StartWebRecord request.

```json
{
    "Response": {
        "TaskId": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri",
        "RequestId": "2a76ee73-6579-42f0-8d57-1f6c9b9d7208"
    }
}
```

--------------------------------

### Start Local Camera Preview

Source: https://trtc.io/zh/document/62044?menulabel=core+sdk&platform=ios&product=rtcengine

Configure render parameters and start local camera preview.

```objective-c
- (void)startLocalPreview {
    // 设置本地预览渲染参数
    TRTCRenderParams *trtcRenderParams = [[TRTCRenderParams alloc] init];
    trtcRenderParams.fillMode   = TRTCVideoFillMode_Fill;
    trtcRenderParams.mirrorType = TRTCVideoMirrorTypeAuto;
    
    AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
    [appDelegate.trtcCloud setLocalRenderParams:trtcRenderParams];
  

    // 对采集内容进行本地预览
    [appDelegate.trtcCloud startLocalPreview:YES view:self.localCameraVideoView];
}
```

--------------------------------

### Start Web Recording Task Request

Source: https://trtc.io/zh/document/72066?menulabel=core+sdk&platform=android&product=rtcengine

Example HTTP POST request to initiate a web recording task with cloud storage configuration.

```http
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartWebRecord
<Common request parameters>

{
    "RecordUrl": "https://web-record-xxxxx.cos.ap-xxx.myqcloud.com/xxxx/xxx.mp4",
    "StorageParams": {
        "CloudStorage": {
            "Vendor": 0,
            "Bucket": "webrecord-1234589",
            "Region": "ap-chengdu",
            "AccessKey": "AKxxxxxx",
            "SecretKey": "Idxxxxxx",
            "FileNamePrefix": [
                "record",
                "video"
            ]
        }
    },
    "SdkAppId": 1600011111,
    "MaxDurationLimit": 3600,
    "WebRecordVideoParams": {
        "Width": 1280,
        "Height": 720,
        "Format": "mp4"
    }
}
```

--------------------------------

### Configure and Start Local Preview

Source: https://trtc.io/zh/document/64203?menulabel=core+sdk&platform=flutter&product=rtcengine

Set rendering parameters and start the local camera preview for either front or back cameras.

```dart
// 设置本地预览渲染参数
trtcCloud.setLocalRenderParams(
  TRTCRenderParams(
    fillMode: TRTCVideoFillMode.fill,
    mirrorType: TRTCVideoMirrorType.auto,
    rotation: TRTCVideoRotation.rotation0,
  ),
);

// 对前置摄像头采集内容进行本地预览
trtcCloud.startLocalPreview(true, localViewId);

// 对后置摄像头采集内容进行本地预览
trtcCloud.startLocalPreview(false, localViewId);
```

--------------------------------

### APNs Start Request Payload Example

Source: https://trtc.io/zh/document/69235?menulabel=core+sdk&platform=ios&product=push

Example JSON structure for an APNs start request. The AttributesType must match the client-side class name, and all required fields must be present for successful decoding.

```json
 {
  // 其他参数...
  "OfflinePushInfo": {
      "Title": "离线推送标题",
      "Desc": "离线推送内容",
      "Ext": "{\"entity\":{\"k1\":\"v1\",\"k2\":\"v2\"}}", // 透传字段，建议长度不超过1k
      "ApnsInfo": {
           "LiveActivity": {
               "Event": "start",                           // 启动 LiveActivity 推送
               "AttributesType": "LiveActivityAttributes", // 实时活动属性类型名称，与客户端定义的类型结构体名称完全一致。
               "Attributes":{
                   "k1": "v1",
                   "k2": "k2",
                   ...
               },
               "ContentState": {
                   "k1": "v1",
                   "k2": "v2",
                   ...
                }
            }
        },
        "AndroidInfo": {
            ... // 详情参见 AndroidInfo 字段说明
        }
  }
}
```

--------------------------------

### Start the development server

Source: https://trtc.io/zh/document/54845?menulabel=uikit&platform=web&product=conference

Commands to launch the project using different package managers.

```bash
npm run dev
```

```bash
pnpm run dev
```

```bash
yarn run dev
```

--------------------------------

### void startLocalPreview(TXView view)

Source: https://trtc.io/zh/document/50770

Starts the local camera preview on desktop devices.

```APIDOC
## void startLocalPreview(TXView view)

### Description
Starts the local camera preview for desktop platforms. You can call setCurrentDevice before this to select the camera.

### Parameters
- **view** (TXView) - Required - The control element that renders the video.
```

--------------------------------

### CreateCloudRecording Request Example

Source: https://trtc.io/zh/document/46960?menulabel=core+sdk&platform=electron&product=rtcengine

Example request payload for starting a cloud recording session with specific storage, recording, and layout parameters.

```http
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudRecording
<Common request parameters>

{
    "StorageParams": {
        "CloudVod": {
            "TencentVod": {
                "ExpireTime": 0
            }
        }
    },
    "UserSig": "eJw1jcEKgkAURX9FZlvYc3SaC***PiwmafL9rfNX4_",
    "UserId": "10001",
    "RecordParams": {
        "MaxIdleTime": 60,
        "StreamType": 0,
        "RecordMode": 2
    },
    "RoomIdType": 1,
    "MixTranscodeParams": {
        "VideoParams": {
            "Width": 360,
            "BitRate": 500000,
            "Fps": 15,
            "Height": 640,
            "Gop": 10
        }
    },
    "MixLayoutParams": {
        "MixLayoutMode": 3
    },
    "SdkAppId": 1400188366,
    "RoomId": "3560"
}
```

--------------------------------

### AI Start of Speech Event Callback Payload

Source: https://trtc.io/zh/document/68331?product=conversationalai

Example JSON payload for the 'AI Start of Speech' event (EventType 904).

```json
{	
	"EventGroupId":	 9,
	"EventType":	 904,
 	"CallbackTs":	 1687770730166,
  	"EventInfo": { 
   	    "EventMsTs": 1622186275757, 
        "TaskId": "xx", 
      	"RoomId": "1234",
      	"RoomIdType": 0,  
        "Payload": {
 		   "UserId": "xxx",
           "RoundId": "xxxxx"
        }
	}
}
```

--------------------------------

### startLocalAudio:

Source: https://trtc.io/zh/document/50754

Starts local audio capture and publishing to the current room.

```APIDOC
## startLocalAudio:

### Description
Starts microphone capture, encodes the audio, and publishes it to the room. SDK automatically requests microphone permissions if not granted.

### Method
Objective-C Method

### Signature
- (void)startLocalAudio:(TRTCAudioQuality)quality

### Parameters
- **quality** (TRTCAudioQuality) - Required - Audio quality setting (Speech, Default, or Music).
```

--------------------------------

### AI Task Start Event Callback Payload

Source: https://trtc.io/zh/document/68331?product=conversationalai

Example JSON payload for the 'AI Task Started' event (EventType 901).

```json
{	
	"EventGroupId":	 9, 
    "EventType": 901, 
 	"CallbackTs": 1687770730166, 
  	"EventInfo": { 
   	    "EventMsTs": 1622186275757, 
        "TaskId": "hKPD2Q7kBVzu-6ezFiqmcEBJQCykqbZrS9OOTE46uYlb4NvQDIaEXlpOlLXFtGBiado5oP0zfLDZs", 
      	"RoomId": "1234", 
        "RoomIdType": 0, 
        "Payload": {
            "Status": 0
        }
	}
}
```

```json
{	
	"EventGroupId":	9, 
 	"EventType": 901, 
 	"CallbackTs": 1687770730166, 
  	"EventInfo": { 
   	    "EventMsTs": 1622186275757, 
        "TaskId": "xx", 
      	"RoomId": "1234",
      	"RoomIdType": 0, 
        "Payload": {
            "Status": 0
        }
	}
}
```

--------------------------------

### Event Type 301 Payload Example

Source: https://trtc.io/zh/document/80345

Callback payload for the cloud recording start event.

```json
{
    "EventGroupId": 3,
    "EventType": 301,
    "CallbackTs": 1622186275913,
    "EventInfo": {
        "RoomId": "635055",
        "EventTs": "1622186275",
        "EventMsTs": 1622186275757,
        "UserId": "user1",
        "TaskId": "-m9-bVVU7id***K-m928oZWQndiborbEWH3zY-lIXlprc-gQvQE",
        "Payload": {
            "Status": 0
        }
    }
}
```

--------------------------------

### startPreview(source)

Source: https://trtc.io/zh/document/81193?menulabel=core+sdk&platform=web&product=beautyar

Starts real-time video preview.

```APIDOC
## startPreview(source)

### Description
Starts the real-time preview and returns a MediaStream that can be assigned to a video element's srcObject.
```

--------------------------------

### startPublish()

Source: https://trtc.io/zh/document/64354

Starts local media mixing and stream publishing.

```APIDOC
## startPublish()

### Description
Initiates local mixing and pushes the stream. Note: This operation can only be performed after successfully joining a room.

### Returns
- **Promise<void>**
```

--------------------------------

### startSystemAudioLoopback

Source: https://trtc.io/zh/document/50762?menulabel=core+sdk&platform=android&product=rtcengine

Starts capturing system audio to mix into the current audio stream, allowing other users in the room to hear audio from other applications.

```APIDOC
## startSystemAudioLoopback

### Description
Starts system audio capture. This interface captures audio data from other applications and mixes it into the SDK's current audio stream.

### Notes
- Only effective on Android API 29 and above.
- Must be called before screen sharing to take effect.
- Requires a foreground service with `android:foregroundServiceType="mediaProjection"`.
```

--------------------------------

### startCamera

Source: https://trtc.io/zh/document/69844?menulabel=uikit&platform=ios&product=live

Starts the local camera preview for the host.

```APIDOC
### startCamera(useFrontCamera: Bool, completion: (() -> Void)?, onError: ((Int, String) -> Void)?)

Starts the local camera preview. This does not start the live stream itself.

- **useFrontCamera** (Bool) - Whether to use the front-facing camera.
- **completion** (Closure) - Optional callback for success.
- **onError** (Closure) - Optional callback for error handling with code and message.
```

--------------------------------

### Configure Audio Effects and Music

Source: https://trtc.io/zh/document/64353

Example showing how to initialize the audio effect manager, set voice effects, and start playing background music with event observers.

```typescript
import TUIRoomEngine, {
  TUIAudioEffectManager, TUIVoiceReverbType, TUIVoiceChangerType
} from '@tencentcloud/tuiroom-engine-electron';

const audioEffectManager: TUIAudioEffectManager = TUIRoomEngine.getAudioEffectManager();
audioEffectManager.setVoiceReverbType(TUIVoiceReverbType.kVoiceReverbType_3);
audioEffectManager.setVoiceChangerType(TUIVoiceChangerType.kVoiceChangerType_1);

audioEffectManager.setMusicObserver({
  onStart: (id: number, errCode: number)=>{
    console.log(`music start play:`, id, errCode);
  },
  onPlayProgress: (id: number, curPtsMS: number, durationMS: number) => {
    console.log(`music play progress:`, id, curPtsMS, durationMS);
  },
  onComplete: (id: number, errCode: number) => {
    console.log(`music complete:`, id, errCode);
  },
});
audioEffectManager.startPlayMusic({
  id: 1,
  path: 'https://web.sdk.qcloud.com/trtc/electron/download/resources/media/bgm/PositiveHappyAdvertising.mp3',
  publish: true,
  loopCount: 2,
  isShortFile: false,
  startTimeMS: 0,
  endTimeMS: 0,
});
```

--------------------------------

### start

Source: https://trtc.io/zh/document/54880?menulabel=uikit&platform=web&product=conference

Starts a new meeting.

```APIDOC
## start

### Description
Starts a new meeting.

### Parameters
- **roomId** (string) - Required - The meeting room ID.
- **params** (StartParams) - Required - Parameters for starting the meeting.

### Returns
Promise<void>
```

--------------------------------

### StartPublishCdnStream Request Example

Source: https://trtc.io/zh/document/48247?product=rtcengine

Example of a POST request to initiate a CDN stream push with specific audio, video, layout, and SEI parameters.

```http
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartPublishCdnStream
<Common request parameters>

{
    "AgentParams": {
        "MaxIdleTime": 30,
        "UserSig": "eJw1zV8LgjAUBfCvInsO2dStGfQSQUb2pFJvsnLJJZW1LekPffdc6X08v8O5b5Snmd9LjRYeCnyMZt4vgUp2Fi7wB6vtuVRC207q0kpjSzIVTXUVSkE11EiEMeE8ZGw0*VCg5SCcDeRuBAutiwkLeRRwOo*nMajduy5O*gIaus9qel9vX*lJbHJmyDMxuKFFI27tsT*I1S6pl*jzBb*IOTE_",
        "UserId": "trtc_partner_test_1"
    },
    "AudioParams": {
        "AudioEncode": {
            "SampleRate": 48000,
            "Codec": 0,
            "BitRate": 64,
            "Channel": 2
        }
    },
    "VideoParams": {
        "VideoEncode": {
            "Height": 720,
            "Width": 1280,
            "Fps": 15,
            "BitRate": 1536,
            "Gop": 2
        },
        "LayoutParams": {
            "PureAudioHoldPlaceMode": 0,
            "MixLayoutMode": 4,
            "MixLayoutList": [
                {
                    "LocationX": 0,
                    "LocationY": 0,
                    "UserMediaStream": {
                        "StreamType": 0,
                        "UserInfo": {
                            "RoomIdType": 0,
                            "RoomId": "295066",
                            "UserId": "Trtc_User_0"
                        }
                    },
                    "ZOrder": 0,
                    "ImageHeight": 720,
                    "ImageWidth": 640,
                    "RenderMode": 0
                },
                {
                    "LocationX": 640,
                    "LocationY": 0,
                    "UserMediaStream": {
                        "StreamType": 0,
                        "UserInfo": {
                            "RoomIdType": 0,
                            "RoomId": "295066",
                            "UserId": "Trtc_User_1"
                        }
                    },
                    "ZOrder": 0,
                    "ImageHeight": 720,
                    "ImageWidth": 640,
                    "RenderMode": 0
                }
            ]
        },
        "BackGroundColor": "0xFF0000",
        "WaterMarkList": [
            {
                "WaterMarkType": 0,
                "WaterMarkImage": {
                    "LocationX": 64,
                    "LocationY": 64,
                    "WaterMarkHeight": 64,
                    "WaterMarkWidth": 64,
                    "WaterMarkUrl": "https://xkt-course-1304449343.cos.ap-beijing.myqcloud.com/test/mark/37f9eb62-ca72-430e-bfca-e700b59b20e0.png",
                    "ZOrder": 3
                }
            }
        ]
    },
    "SeiParams": {
        "LayoutVolume": {
            "AppData": "layout_sei_test",
            "PayloadType": 100,
            "Interval": 1000,
            "FollowIdr": 1
        }
    },
    "PublishCdnParams": [
        {
            "PublishCdnUrl": "rtmp://3891.livepush.myqcloud.com/live/trtc_publishcdn_test1",
            "IsTencentCdn": 1
        }
    ],
    "RoomIdType": 0,
    "SdkAppId": 1400188366,
    "WithTranscoding": 1,
    "RoomId": "295066"
}
```

--------------------------------

### Start Screen Share

Source: https://trtc.io/zh/document/78045

Starts the screen sharing functionality.

```kotlin
abstract fun startScreenShare()
```

--------------------------------

### Run Development Server

Source: https://trtc.io/zh/document/50055?menulabel=uikit&platform=web&product=chat

Command to start the local development environment.

```bash
 npm run dev
```

--------------------------------

### Start Remote View

Source: https://trtc.io/zh/document/62044?menulabel=core+sdk&platform=ios&product=rtcengine

Start playing a remote video stream.

```objective-c
- (void)startRemoteView {
    // 播放远端画面
    AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
    [appDelegate.trtcCloud startRemoteView:@"denny" streamType:TRTCVideoStreamTypeBig view:self.localCameraVideoView];
}
```

--------------------------------

### StartPublishCdnStream Request Example

Source: https://trtc.io/zh/document/48247?product=rtcengine

HTTP POST request to initiate a mixed stream push to a CDN, including agent, audio, video, and layout configurations.

```http
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartPublishCdnStream
<Common request parameters>

{
    "AgentParams": {
        "MaxIdleTime": 30,
        "UserSig": "eJw1zV8LgjAUBfCvInsO2dStGfQSQUb2pFJvsnLJJZW1LekPffdc6X08v8O5b5Snmd9LjRYeCnyMZt4vgUp2Fi7wB6vtuVRC207q0kpjSzIVTXUVSkE11EiEMeE8ZGw0*VCg5SCcDeRuBAutiwkLeRRwOo*nMajduy5O*gIaus9qel9vX*lJbHJmyDMxuKFFI27tsT*I1S6pl*jzBb*IOTE_",
        "UserId": "trtc_partner_test_1"
    },
    "AudioParams": {
        "AudioEncode": {
            "SampleRate": 48000,
            "Codec": 0,
            "BitRate": 64,
            "Channel": 2
        }
    },
    "VideoParams": {
        "VideoEncode": {
            "Height": 720,
            "Width": 1280,
            "Fps": 15,
            "BitRate": 1536,
            "Gop": 2
        },
        "LayoutParams": {
            "PureAudioHoldPlaceMode": 0,
            "MixLayoutMode": 4,
            "MixLayoutList": [
                {
                    "LocationX": 0,
                    "LocationY": 0,
                    "UserMediaStream": {
                        "StreamType": 0,
                        "UserInfo": {
                            "RoomIdType": 0,
                            "RoomId": "295066",
                            "UserId": "Trtc_User_0"
                        }
                    },
                    "ZOrder": 0,
                    "ImageHeight": 720,
                    "ImageWidth": 640,
                    "RenderMode": 0
                },
                {
                    "LocationX": 640,
                    "LocationY": 0,
                    "UserMediaStream": {
                        "StreamType": 0,
                        "UserInfo": {
                            "RoomIdType": 0,
                            "RoomId": "295066",
                            "UserId": "Trtc_User_1"
                        }
                    },
                    "ZOrder": 0,
                    "ImageHeight": 720,
                    "ImageWidth": 640,
                    "RenderMode": 0
                }
            ]
        },
        "BackGroundColor": "0xFF0000",
        "WaterMarkList": [
            {
                "WaterMarkType": 0,
                "WaterMarkImage": {
                    "LocationX": 64,
                    "LocationY": 64,
                    "WaterMarkHeight": 64,
                    "WaterMarkWidth": 64,
                    "WaterMarkUrl": "https://xkt-course-1304449343.cos.ap-beijing.myqcloud.com/test/mark/37f9eb62-ca72-430e-bfca-e700b59b20e0.png",
                    "ZOrder": 3
                }
            }
        ]
    },
    "PublishCdnParams": [
        {
            "PublishCdnUrl": "rtmp://3891.livepush.myqcloud.com/live/trtc_publishcdn_test1",
            "IsTencentCdn": 1
        }
    ],
    "RoomIdType": 0,
    "SdkAppId": 1400188366,
    "WithTranscoding": 1,
    "RoomId": "295066"
}
```

--------------------------------

### Start Camera Test

Source: https://trtc.io/zh/document/64352

Starts a camera test within a specific window area.

```typescript

import TUIRoomEngine, {
  TUIDeviceManager, TUIRect
} from '@tencentcloud/tuiroom-engine-electron';

const deviceManager:TUIDeviceManager = TUIRoomEngine.getDeviceManager();
const rect: TUIRect = {
  left: 100,
  top: 50,
  right: 740,
  bottom: 410,
};
const windowID: Uint8Array; // 通过 Electron API BrowserWindow.getNativeWindowHandle() 拿到
deviceManager.startCameraDeviceTest(windowID, rect);

```

--------------------------------

### new ArRecorder.ArRecorderSdk(options)

Source: https://trtc.io/zh/document/81193?menulabel=core+sdk&platform=web&product=beautyar

Initializes a new instance of the ArRecorder SDK with the specified configuration.

```APIDOC
## new ArRecorder.ArRecorderSdk(options)

### Description
Initializes the ArRecorder SDK instance with authentication, beautification, and output settings.

### Parameters
- **auth** (Object) - Required - Authentication parameters including licenseKey, appId, and authFunc.
- **beautify** (BeautifyOptions) - Optional - Beautification settings.
- **module** (Object) - Optional - Module configuration, specifically faceDetectModel.
- **output** (Object) - Optional - MP4 encoding configuration (codec, bitrate, fps).
- **initReport** (Boolean) - Optional - Whether to initialize the logging module (default: true).
```

--------------------------------

### Start Local Audio

Source: https://trtc.io/zh/document/62044?menulabel=core+sdk&platform=ios&product=rtcengine

Start microphone capture with specific audio quality settings.

```objective-c
// 开启麦克风采集，设置当前场景为:语音模式
// 具有高的噪声抑制能力，有强有弱的网络阻力
AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
[appDelegate.trtcCloud startLocalAudio:TRTCAudioQualitySpeech];
```

```objective-c
// 开启麦克风采集，设置当前场景为:音乐模式
// 为获得高保真度，低音质损失，建议配合专业声卡使用
AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
[appDelegate.trtcCloud startLocalAudio:TRTCAudioQualityMusic];
```

--------------------------------

### startAudioRecording:

Source: https://trtc.io/zh/document/50754?menulabel=core+sdk&platform=macos&product=rtcengine

Starts recording local and remote audio to a local file.

```APIDOC
## startAudioRecording:(TRTCAudioRecordingParams*)param

### Description
Starts recording all audio (local, remote, background music, and sound effects) to a local file. This can be called before or after joining a room.

### Parameters
- **param** (TRTCAudioRecordingParams*) - Required - Recording parameters.

### Returns
- **int** - 0: Success; -1: Recording already started; -2: File/directory creation failed; -3: Unsupported audio format.
```

--------------------------------

### Install iOS Dependencies

Source: https://trtc.io/zh/document/56573?menulabel=uikit&platform=react+native&product=chat

Commands to navigate to the iOS directory and install CocoaPods dependencies.

```bash
cd ios
pod install
```

--------------------------------

### Install TUIRoomEngine SDK

Source: https://trtc.io/zh/document/54878

Use a package manager to install the TUIRoomEngine SDK into your project.

```bash
// 使用 npm
npm i @tencentcloud/tuiroom-engine-js --save
```

```bash
// 使用 pnpm
pnpm i @tencentcloud/tuiroom-engine-js --save
```

```bash
// 使用 yarn
yarn add @tencentcloud/tuiroom-engine-js
```

--------------------------------

### startAudioRecording:

Source: https://trtc.io/zh/document/50754

Starts recording all local and remote audio (including background music and sound effects) into a local file.

```APIDOC
## startAudioRecording:

### Description
Starts recording all local and remote audio into a local file. This can be called before or after entering a room.

### Parameters
- **param** (TRTCAudioRecordingParams*) - Required - Recording parameters.

### Returns
- **int** - 0: Success; -1: Recording already started; -2: File/directory creation failed; -3: Unsupported audio format.
```

--------------------------------

### Install TUICallKit Component

Source: https://trtc.io/zh/document/50993?menulabel=uikit&platform=web&product=call

Install the required npm package for the TUICallKit Vue component.

```bash
npm install @trtc/calls-uikit-vue
```

--------------------------------

### init

Source: https://trtc.io/zh/document/51006?menulabel=uikit&platform=android&product=call

Initializes the service, including authentication.

```APIDOC
## init

### Description
Initializes the service. Must be called before using any other features.

### Parameters
- **sdkAppId** (int) - Required - SDKAppID from the console.
- **userId** (String) - Required - Current user ID.
- **userSig** (String) - Required - Security signature.
- **callback** (TUICommonDefine.Callback) - Required - Initialization callback.
```

--------------------------------

### DescribeCallDetailInfo API Response Example

Source: https://trtc.io/zh/document/55013

Example of a successful JSON response from the DescribeCallDetailInfo API.

```json
{
    "Response": {
        "Total": 1,
        "UserList": [
            {
                "RoomStr": "218695",
                "UserId": "1716",
                "JoinTs": 1590065777,
                "LeaveTs": 1590067658,
                "Finished": true,
                "DeviceType": "",
                "SdkVersion": "4.3.14",
                "ClientIp": "10.4.1.13"
            }
        ],
        "Data": [
            {
                "Content": [
                    {
                        "Time": 1590065779,
                        "Value": 0
                    },
                    {
                        "Time": 1590065781,
                        "Value": 0
                    },
                    {
                        "Time": 1590065783,
                        "Value": 0
                    },
                    {
                        "Time": 1590065785,
                        "Value": 0
                    },
                    {
                        "Time": 1590065787,
                        "Value": 0
                    },
                    {
                        "Time": 1590065789,
                        "Value": 0
                    }
                ],
                "PeerId": "",
                "UserId": "1716",
                "DataType": "bigvCapFps"
            }
        ],
        "RequestId": "2e12e365-43e8-4efd-902d-906303e2ee4a"
    }
}
```
Tokens:
Raw