ts-onvif/build/receiver.d.ts

Client to ONVIF devices

/**
 * Receiver ver10 module
 * @author Andrew D.Laptev <a.d.laptev@gmail.com>
 * @see https://www.onvif.org/ver10/receiver/wsdl
 */
import { Onvif } from './onvif';
import Service from './service';
import { Receiver as ReceiverInfo, ReceiverStateInformation } from './interfaces/onvif';
import { Capabilities, ConfigureReceiver, CreateReceiver, CreateReceiverResponse, DeleteReceiver, GetReceiver, GetReceiverState, SetReceiverMode } from './interfaces/receiver';
/**
 * Receiver service
 */
export default class Receiver extends Service {
    constructor(onvif: Onvif);
    private static receiverConfigurationToBuild;
    /**
     * Returns the capabilities of the receiver service.
     */
    getServiceCapabilities(): Promise<Capabilities>;
    /**
     * Returns all receivers on the device.
     */
    getReceivers(): Promise<ReceiverInfo[]>;
    /**
     * Returns a receiver by token.
     * @param options
     */
    getReceiver({ receiverToken }: GetReceiver): Promise<ReceiverInfo>;
    /**
     * Creates a new receiver.
     * @param options
     */
    createReceiver({ configuration }: CreateReceiver): Promise<CreateReceiverResponse['receiver']>;
    /**
     * Deletes a receiver.
     * @param options
     */
    deleteReceiver({ receiverToken }: DeleteReceiver): Promise<void>;
    /**
     * Configures an existing receiver.
     * @param options
     */
    configureReceiver({ receiverToken, configuration }: ConfigureReceiver): Promise<void>;
    /**
     * Sets the connection mode of a receiver.
     * @param options
     */
    setReceiverMode({ receiverToken, mode }: SetReceiverMode): Promise<void>;
    /**
     * Returns the current state of a receiver.
     * @param options
     */
    getReceiverState({ receiverToken }: GetReceiverState): Promise<ReceiverStateInformation>;
}