import type { ConnectionKey } from '../models/ConnectionKey'; import type { ErrorResponse } from '../models/ErrorResponse'; import type { HSSPPlay } from '../models/HSSPPlay'; import type { HSSPPlayResponse } from '../models/HSSPPlayResponse'; import type { HSSPSetupResult } from '../models/HSSPSetupResult'; import type { HSSPState } from '../models/HSSPState'; import type { LoopSettingResponse } from '../models/LoopSettingResponse'; import type { LoopSettingUpdate } from '../models/LoopSettingUpdate'; import type { RPCResult } from '../models/RPCResult'; import type { Setup } from '../models/Setup'; import type { CancelablePromise } from '../core/CancelablePromise'; import type { BaseHttpRequest } from '../core/BaseHttpRequest'; export declare class HsspService { readonly httpRequest: BaseHttpRequest; constructor(httpRequest: BaseHttpRequest); /** * Start script playing. * Start script playing from a specified time index.

For the script and a video to be correctly synchronized, the client must provide a client-side-estimated-server-time.

See TIMESYNC for further details on how to create a good client-side-estimated-server-time. * @param xConnectionKey Device connection key. * @param requestBody * @returns any HSSPPlayResponse * @throws ApiError */ play(xConnectionKey: ConnectionKey, requestBody: HSSPPlay): CancelablePromise<(HSSPPlayResponse | ErrorResponse)>; /** * Stop script playing. * Stop script playing. * @param xConnectionKey Device connection key. * @returns any HSSPStopResponse * @throws ApiError */ hsspStop(xConnectionKey: ConnectionKey): CancelablePromise<(ErrorResponse | RPCResult)>; /** * Setup script synchronization. * Setup script synchronization by providing the device with an URL from where the script can be downloaded. The device need to be able to access the URL for setup to work.

NOTE: The maximum CSV script size that a device can handle is 524288 bytes. Script larger than this will return an error.

If the sha-256 value of the script is provided, the device will only download the script if it can not be found in the device cache.

See the hssp/setup response examples and the HSSPModeErrors schema for possible responses and error code descriptions.

Using token URLs

NOTE: This secions is only applicable for partners that have integrated with the Script API.

If the URL provided to the hssp/setup is a token URL, the sha-256 value is ignored. In addition, more information is available in potential error responses if the error is caused by the token.

* @param xConnectionKey Device connection key. * @param requestBody * @returns any SetupResponse * @throws ApiError */ setup(xConnectionKey: ConnectionKey, requestBody: Setup): CancelablePromise<(ErrorResponse | { result: HSSPSetupResult; })>; /** * Get the HSSP loop setting of the device. Only available in firmware >= 3.2.x * Get the HSSP loop setting of the device. Only available in firmware >= 3.2.x * @param xConnectionKey Device connection key. * @returns any LoopSettingResponse * @throws ApiError */ getLoopSetting(xConnectionKey: ConnectionKey): CancelablePromise<(ErrorResponse | LoopSettingResponse)>; /** * Set the HSSP loop setting of the device. Only available in firmware >= 3.2.x * If looping is enabled, the device will start replaying the script from the beginning when the end of the script is reached. Only available in firmware >= 3.2.x * @param xConnectionKey Device connection key. * @param requestBody * @returns any RPCResult * @throws ApiError */ setLoopSetting(xConnectionKey: ConnectionKey, requestBody: LoopSettingUpdate): CancelablePromise<(ErrorResponse | RPCResult)>; /** * Get the HSSP state of the device. * Get the HSSP state of the device. * @param xConnectionKey Device connection key. * @returns any HSSPState * @throws ApiError */ getHsspState(xConnectionKey: ConnectionKey): CancelablePromise<(ErrorResponse | (RPCResult & { state: HSSPState; }))>; }