Main Entry (HWLLSPlayer)

checkSystemRequirements

checkSystemRequirements(): Promise<boolean>

[Function Description]

Checks whether the browser supports the LLL web SDK.

[Request Parameters]

None

[Response Parameters]

Promise<boolean>: A Promise object is returned. The value true indicates that the browser is compatible with the LLL web SDK. If they are incompatible, an error is returned.

CAUTION:

LLL requires the WebRTC capability but some browsers may not support WebRTC playback. In this case, you can downgrade the playback based on the specific error code (HWLLS_ERROR_WEBRTC_UNSUPPORTED). For details, see SDK Usage.

getVersion

getVersion(): string

[Function Description]

Obtains the current SDK version number.

[Request Parameters]

None

[Response Parameters]

string: current SDK version number.

createClient

createClient(): HWLLSClient

[Function Description]

Creates a client object for pulling live streams. If multiple live streams need to be pulled, you need to create multiple client objects.

[Request Parameters]

None

[Response Parameters]

client: client object for pulling streams.

createClient (Earlier than 2.10.6)

createClient(type: string): HWLLSClient | HWFlvClient | HWHlsClient

[Function Description]

Creates a client object for livestream pull. If multiple livestreams need to be pulled, you need to create multiple client objects.

[Request Parameters]

type: (optional) String type. Indicates the type of the client created for stream pull.

• Type of the client for pulling LLL streams: webrtc
• Type of the client for pulling FLV streams: flv
• Type of the client for pulling HLS streams: hls (reserved)

Default value: webrtc

[Response Parameters]

client: client object created for stream pull

CAUTION:

SDK 2.10.6 and later versions do not support the independent use of the HWFlvClient and HWHlsClient players. If you are using SDK of an earlier version, refer to Client Object (HWFlvClient) and Client Object (HWHlsClient).

uploadLog

async uploadLog(): Promise<void>

[Function Description]

Uploads logs.

[Request Parameters]

None

[Response Parameters]

Promise<void>: If tryCatch is used to obtain errors as an array, error information corresponding to multiple app IDs will be returned.

saveLog

async saveLog(): Promise<Blob>

[Function Description]

Users can flexibly save logs.

[Request Parameters]

None

[Response Parameters]

Promise<Blob>: Promise<Blob> compressed in .zip format, which can be directly saved as a .zip file.

setParameter

setParameter(parameterKey: string, parameterValue: any): boolean

[Function Description]

Configures global parameters.

[Request Parameters]

[Response Parameters]

boolean: configuration parameter setting result. true indicates that the setting is successful. false indicates that the setting fails.

setLogLevel

setLogLevel(level: string): boolean

[Function Description]

Set the level of logs to be printed on the console. Otherwise, the default level is error.

[Request Parameters]

level: (mandatory) String type. A log level identifier.

• none: Disables the function of printing logs of all levels.
• error: Logs of the error level are printed.
• warn: Logs of the warn level and higher levels are printed.
• info: Logs of the info level and higher levels are printed.
• debug: Logs of the debug level and higher levels are printed.

[Response Parameters]

boolean: log level setting result. true indicates that the log level is set successfully. false indicates that the log level fails to be set.

setReportConfig

setReportConfig(reportConfig:ReportConfig):boolean

[Function Description]

Sets the dotting capability and the authentication policy for dotting and log uploading.

[Request Parameters]

reportConfig: (mandatory) ReportConfig type. reportConfig is defined as follows:

• enable: (mandatory) The value is of the Boolean type. true (default) indicates that dotting is enabled, and false indicates that dotting is disabled.
• tokenConfig: (optional) The object definition is as follows:
  • enable: The value is of the Boolean type. true indicates that authentication is enabled, and false (default) indicates that authentication is disabled.
  • tokenInfo: The value is of the array type. The array contains the ReportTokenInfo class. ReportTokenInfo is defined as follows:
    • appid: The value is of the string type.
    • expTimestamp: The value is of the string type, indicating the expiration timestamp. The value is the current UNIX timestamp plus the authentication expiration time. The recommended value is 7200 seconds. The maximum value is 43200 seconds, that is, 12 hours.

      For example, if the current UNIX timestamp is 1708531200 and the authentication expiration time is 7200 seconds, the expiration timestamp is 1708538400, indicating that the verification string expires at 02:00:00 on February 22, 2024.

    • token: The value is of the string type. It is a string generated by hmac_sha256. hmac_sha256 (shared key, expiration timestamp + appID) The shared key is controlled and obtained by the user.

[Response Parameters]

A Boolean value is returned. Returns true if the value is set successfully; returns false otherwise.

If the authentication policy is enabled, the actual request status is obtained by registering the Error callback through the on function.

on

on(event: string, handler: function, withTimeout?: boolean): void

[Function Description]

Registers the callback for a client object event.

[Response Parameters]

None

off

off(event: string, handler: function): void

[Function Description]

Deregisters the callback for a client object event.

[Response Parameters]

None