opentok-network-test-js
Version:
Precall network test for applications using the OpenTok platform.
24 lines • 972 B
TypeScript
/**
* @module Test/Publishing
* @preferred
*
* Defines the methods required for the Publishing Test Flow
*/
/**
* Publishing Test Flow
*/
import OTKLogger from '@opentok/opentok-solutions-logging';
import { NetworkTestOptions } from '../index';
import { AverageStats, HasAudioVideo } from './types/stats';
import { UpdateCallback } from '../types/callbacks';
import { SessionCredentials } from '../types/session';
export interface QualityTestResults extends HasAudioVideo<AverageStats> {
networkCondition?: OT.NetworkCondition;
networkDegradationSource?: OT.NetworkDegradationSource;
}
/**
* This method checks to see if the client can publish to an OpenTok session.
*/
export declare function testQuality(OTInstance: typeof OT, credentials: SessionCredentials, otLogging: OTKLogger, options?: NetworkTestOptions, onUpdate?: UpdateCallback): Promise<QualityTestResults>;
export declare function stopQualityTest(): void;
//# sourceMappingURL=index.d.ts.map