Class ConnectionCheck

Hierarchy

TypedEventEmitter<ConnectionCheckCallbacks, this>
- ConnectionCheck

Index

Constructors

Properties

options token url

Methods

checkCloudRegion checkConnectionProtocol checkPublishAudio checkPublishVideo checkReconnect checkTURN checkWebRTC checkWebsocket createAndRunCheck getResults isSuccess

Constructors

constructor

new ConnectionCheck(
    url: string,
    token: string,
    options?: CheckerOptions,
): ConnectionCheck
Parameters
- url: string
- token: string
- options: CheckerOptions = {}
Returns ConnectionCheck
Overrides (EventEmitter as new () => TypedEmitter<ConnectionCheckCallbacks>).constructor
- Defined in src/connectionHelper/ConnectionCheck.ts:25

Properties

options

options: CheckerOptions = {}

token

token: string

url

url: string

Methods

checkCloudRegion

checkCloudRegion(): Promise<CheckInfo>
Returns Promise<CheckInfo>
- Defined in src/connectionHelper/ConnectionCheck.ts:101

checkConnectionProtocol

checkConnectionProtocol(): Promise<CheckInfo>
Returns Promise<CheckInfo>
- Defined in src/connectionHelper/ConnectionCheck.ts:92

checkPublishAudio

checkPublishAudio(): Promise<CheckInfo>
Returns Promise<CheckInfo>
- Defined in src/connectionHelper/ConnectionCheck.ts:84

checkPublishVideo

checkPublishVideo(): Promise<CheckInfo>
Returns Promise<CheckInfo>
- Defined in src/connectionHelper/ConnectionCheck.ts:88

checkReconnect

checkReconnect(): Promise<CheckInfo>
Returns Promise<CheckInfo>
- Defined in src/connectionHelper/ConnectionCheck.ts:80

checkTURN

checkTURN(): Promise<CheckInfo>
Returns Promise<CheckInfo>
- Defined in src/connectionHelper/ConnectionCheck.ts:76

checkWebRTC

checkWebRTC(): Promise<CheckInfo>
Returns Promise<CheckInfo>
- Defined in src/connectionHelper/ConnectionCheck.ts:72

checkWebsocket

checkWebsocket(): Promise<CheckInfo>
Returns Promise<CheckInfo>
- Defined in src/connectionHelper/ConnectionCheck.ts:68

createAndRunCheck

createAndRunCheck<T extends Checker>(
check: InstantiableCheck<T>,
): Promise<CheckInfo>
Type Parameters
- T extends Checker
Parameters
- check: InstantiableCheck<T>
Returns Promise<CheckInfo>
- Defined in src/connectionHelper/ConnectionCheck.ts:56

getResults

getResults(): CheckInfo[]
Returns CheckInfo[]
- Defined in src/connectionHelper/ConnectionCheck.ts:52

isSuccess

isSuccess(): boolean
Returns boolean
- Defined in src/connectionHelper/ConnectionCheck.ts:48