Tuguan Unified Development API

https://www.tuguan.net/doc/tg-api4/
Admin
Tuguan Unified Development API is a JavaScript-based programming interface for loading and...
Tokens:2,592
Snippets:14
Trust Score:4
Update:10 months ago
Show doc for...
Tokens:
Raw
### Get Application Info using uniCall

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation=

Retrieves detailed information about the application's status using the 'getAppInfo' method via uniCall. The callback includes various SDK versions, URLs, and resolution details.

```javascript
appInstance.uniCall('getAppInfo', {}, (result) => {
  console.log(result);
});

```

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

### Get Application Status API

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation=

Retrieves the current status and information of an application instance, including version details, client dimensions, and rendering-specific properties.

```APIDOC
## POST /api/apps/{appId}/status

### Description
Retrieves the status information of an application instance.

### Method
POST

### Endpoint
/api/apps/{appId}/status

### Parameters
#### Path Parameters
- **appId** (string) - Required - The unique identifier of the application instance to query.

#### Query Parameters
None

#### Request Body
- **options** (object) - Optional - Additional options for the request.
  - **callback** (function) - Optional - A callback function to handle the result.

### Request Example
```javascript
appInstance.uniCall('getAppInfo', {}, (result) => {
  console.log(result);
});
```

### Response
#### Success Response (200)
- **result** (Number) - 1 for success, 0 for failure.
- **message** (String) - Success or failure reason.
- **tgApiSdkVer** (String) - Tuguan API version.
- **tgApiDocUrl** (String) - Online address for Tuguan API documentation.
- **clientWidth** (Number) - Current client control width (canvas size for end rendering, actual resolution for streaming).
- **clientHeight** (Number) - Current client control height (canvas size for end rendering, actual resolution for streaming).
- **streamingSdkVer** (String) - Streaming SDK minor version (for streaming rendering only).
- **streamingServerVer** (String) - Streaming server version (for streaming rendering only).
- **streamingEngineVer** (String) - Streaming engine version (for streaming rendering only).
- **streamingWidthMax** (Number) - Maximum width for streaming channel (for streaming rendering only).
- **streamingHeightMax** (Number) - Maximum height for streaming channel (for streaming rendering only).
- **streamingRateMax** (Number) - Maximum bitrate for streaming channel in kbps (for streaming rendering only).
- **streamingFpsMax** (Number) - Maximum frame rate for streaming channel (for streaming rendering only).
- **sceneSdkVer** (String) - Scene SDK minor version (for end rendering only).

#### Response Example
```json
{
  "result": 1,
  "message": "成功。",
  "tgApiSdkVer": "3.3",
  "tgApiDocUrl": "http://www.tuguan.net/doc/tg-api/",
  "clientWidth": 1920,
  "clientHeight": 1080,
  "streamingSdkVer": "3.3.1",
  "streamingServerVer": "3.3",
  "streamingEngineVer": "3.2.1",
  "streamingWidthMax": 1920,
  "streamingHeightMax": 1080,
  "streamingRateMax": 51200,
  "streamingFpsMax": 60,
  "sceneSdkVer": "3.3"
}
```
```

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

### Get Application Status Information API

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation

Details on how to retrieve the status information of an application instance, including various SDK and rendering-specific properties.

```APIDOC
## Get Application Status Information API

### Description
Retrieves the status information of the application.

### Method
`uniCall`

### Endpoint
`getAppInfo` (within `uniCall`)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **`params`** (Object) - Empty object `{}` for this call.

### Request Example
```javascript
appInstance.uniCall('getAppInfo', {}, (result) => {
  console.log(result);
});
```

### Response
#### Success Response (200)
- **`result`** (Number) - 1: Success; 0: Failure.
- **`message`** (String) - Success or failure reason.
- **`tgApiSdkVer`** (String) - Tuguan API version.
- **`tgApiDocUrl`** (String) - Online address for Tuguan API documentation.
- **`clientWidth`** (Number) - Current client control width (canvas size for frame rendering, actual resolution for stream rendering).
- **`clientHeight`** (Number) - Current client control height (canvas size for frame rendering, actual resolution for stream rendering).
- **`streamingSdkVer`** (String) - Streaming rendering SDK minor version (specific to stream rendering).
- **`streamingServerVer`** (String) - Streaming rendering server version (specific to stream rendering).
- **`streamingEngineVer`** (String) - Streaming rendering engine version (specific to stream rendering).
- **`streamingWidthMax`** (Number) - Maximum width for streaming rendering channel (specific to stream rendering).
- **`streamingHeightMax`** (Number) - Maximum height for streaming rendering channel (specific to stream rendering).
- **`streamingRateMax`** (Number) - Maximum bitrate for streaming rendering channel in kbps (specific to stream rendering).
- **`streamingFpsMax`** (Number) - Maximum FPS for streaming rendering channel (specific to stream rendering).
- **`sceneSdkVer`** (String) - Scene SDK minor version (specific to frame rendering).

#### Response Example
```json
{
  "result": 1,
  "message": "成功。",
  "tgApiSdkVer": "3.3",
  "tgApiDocUrl": "http://www.tuguan.net/doc/tg-api/",
  "clientWidth": 1920,
  "clientHeight": 1080,
  "streamingSdkVer": "3.3.1",
  "streamingServerVer": "3.3",
  "streamingEngineVer": "3.2.1",
  "streamingWidthMax": 1920,
  "streamingHeightMax": 1080,
  "streamingRateMax": 51200,
  "streamingFpsMax": 60,
  "sceneSdkVer": "3.3"
}
```
```

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

### Get Application Status Information

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation

Retrieves the current status and information of an application instance using the 'getAppInfo' method via uniCall. The returned data includes API versions, client dimensions, and specific details for streaming or scene rendering.

```javascript
appInstance.uniCall('getAppInfo', {}, (result) => {
  console.log(result);
});
```

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

### Application Construction API

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation=

Provides methods for constructing and initializing a new application instance using the TGApp.App constructor.

```APIDOC
## POST /api/apps

### Description
Constructs a new application instance.

### Method
POST

### Endpoint
/api/apps

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
let appInstance = new TGApp.App();
```

### Response
#### Success Response (200)
- **appInstance** (object) - The newly created application instance.

#### Response Example
```json
{
  "appInstance": "[object TGApp.App]"
}
```
```

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

### Construct Application using TGApp.App

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation=

Initializes a new application instance using the TGApp.App constructor. This is the first step in interacting with the Tuguan API for application management.

```javascript
let appInstance = new TGApp.App();

```

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

### Application Destruction API

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation=

Allows for the destruction and cleanup of an existing application instance. Includes details on the callback data and parameter descriptions.

```APIDOC
## POST /api/apps/{appId}/destroy

### Description
Destroys an application instance.

### Method
POST

### Endpoint
/api/apps/{appId}/destroy

### Parameters
#### Path Parameters
- **appId** (string) - Required - The unique identifier of the application instance to destroy.

#### Query Parameters
None

#### Request Body
- **options** (object) - Optional - Additional options for destruction.
  - **callback** (function) - Optional - A callback function to handle the result.

### Request Example
```javascript
appInstance.uniCall('destroy', {}, (result) => {
  console.log(result);
});
```

### Response
#### Success Response (200)
- **result** (Number) - 1 for success, 0 for failure.
- **message** (String) - Success or failure reason.

#### Response Example
```json
{
  "result": 1,
  "message": "成功。"
}
```
```

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

### Application Destruction API

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation

Provides instructions on how to destroy an existing application instance and the expected callback data.

```APIDOC
## Application Destruction API

### Description
Destroys an existing application instance.

### Method
`uniCall`

### Endpoint
`destroy` (within `uniCall`)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **`params`** (Object) - Empty object `{}` for this call.

### Request Example
```javascript
appInstance.uniCall('destroy', {}, (result) => {
  console.log(result);
});
```

### Response
#### Success Response (200)
- **`result`** (Number) - 1 for success, 0 for failure.
- **`message`** (String) - Success or failure reason.

#### Response Example
```json
{
  "result": 1,
  "message": "成功。"
}
```
```

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

### Application Construction API

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation

This section details how to construct a new application instance using the TGApp.App constructor.

```APIDOC
## Application Construction API

### Description
Constructs a new application instance.

### Method
`new` (Constructor)

### Endpoint
N/A (Client-side instantiation)

### Parameters
None

### Request Example
```javascript
let appInstance = new TGApp.App();
```

### Response
Returns a new application instance.
```

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

### Construct Application using TGApp.App

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation

Instantiates a new application object using the TGApp.App constructor. This is the initial step to interact with the Tuguan API for application management.

```javascript
let appInstance = new TGApp.App();
```

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

### Destroy Application using uniCall

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation=

Destroys an existing application instance by calling the 'destroy' method via uniCall. It logs the result of the destruction operation.

```javascript
appInstance.uniCall('destroy', {}, (result) => {
  console.log(result);
});

```

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

### Destroy Application Instance

Source: https://www.tuguan.net/doc/tg-api4/index_manual.global.application.operation

Destroys an existing application instance by calling the 'destroy' method via uniCall. This operation requires an active appInstance and returns a result indicating success or failure.

```javascript
appInstance.uniCall('destroy', {}, (result) => {
  console.log(result);
});
```
Tokens:
Raw