Interface Receiver

Receiver service

interface Receiver {
    onvif: Onvif;
    service: keyof OnvifServices;
    xmlns: string;
    configureReceiver(options: ConfigureReceiver): Promise<void>;
    createReceiver(options: CreateReceiver): Promise<Receiver>;
    deleteReceiver(options: DeleteReceiver): Promise<void>;
    getReceiver(options: GetReceiver): Promise<Receiver>;
    getReceivers(): Promise<Receiver[]>;
    getReceiverState(
        options: GetReceiverState,
    ): Promise<ReceiverStateInformation>;
    getServiceCapabilities(): Promise<Capabilities>;
    request<T = any>(
        body: Record<string, any>,
        options?: LineraseOptions,
    ): Promise<T>;
    setReceiverMode(options: SetReceiverMode): Promise<void>;
}

Hierarchy (View Summary)

Service
- Receiver

Index

Properties

onvif service xmlns

Methods

configureReceiver createReceiver deleteReceiver getReceiver getReceivers getReceiverState getServiceCapabilities request setReceiverMode

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

configureReceiver

configureReceiver(options: ConfigureReceiver): Promise<void>
Configures an existing receiver.
Parameters
- options: ConfigureReceiver
Returns Promise<void>
- Defined in receiver.ts:98

createReceiver

createReceiver(options: CreateReceiver): Promise<Receiver>
Creates a new receiver.
Parameters
- options: CreateReceiver
Returns Promise<Receiver>
- Defined in receiver.ts:73

deleteReceiver

deleteReceiver(options: DeleteReceiver): Promise<void>
Deletes a receiver.
Parameters
- options: DeleteReceiver
Returns Promise<void>
- Defined in receiver.ts:86

getReceiver

getReceiver(options: GetReceiver): Promise<Receiver>
Returns a receiver by token.
Parameters
- options: GetReceiver
Returns Promise<Receiver>
- Defined in receiver.ts:60

getReceivers

getReceivers(): Promise<Receiver[]>
Returns all receivers on the device.

Returns Promise<Receiver[]>
- Defined in receiver.ts:51

getReceiverState

getReceiverState(options: GetReceiverState): Promise<ReceiverStateInformation>
Returns the current state of a receiver.
Parameters
- options: GetReceiverState
Returns Promise<ReceiverStateInformation>
- Defined in receiver.ts:124

getServiceCapabilities

getServiceCapabilities(): Promise<Capabilities>
Returns the capabilities of the receiver service.

Returns Promise<Capabilities>
- Defined in receiver.ts:41

request

request<T = any>(
body: Record<string, any>,
options?: LineraseOptions,
): Promise<T>
Type Parameters
- T = any
Parameters
- body: Record<string, any>
- Optionaloptions: LineraseOptions
Returns Promise<T>
Inherited from Service.request
- Defined in service.ts:50

setReceiverMode

setReceiverMode(options: SetReceiverMode): Promise<void>
Sets the connection mode of a receiver.
Parameters
- options: SetReceiverMode
Returns Promise<void>
- Defined in receiver.ts:111