_api_receiver_.onvifreceiver.md

onvif-rx › "api/receiver" › ONVIFReceiver

Class: ONVIFReceiver

Hierarchy

• ONVIFReceiver

Index

Constructors

• constructor

Properties

• config

Methods

• ConfigureReceiver
• CreateReceiver
• DeleteReceiver
• GetReceiver
• GetReceiverState
• GetReceivers
• GetServiceCapabilities
• SetReceiverMode
• ConfigureReceiver
• CreateReceiver
• DeleteReceiver
• GetReceiver
• GetReceiverState
• GetReceivers
• GetServiceCapabilities
• SetReceiverMode

Constructors

constructor

+ new ONVIFReceiver(config: IDeviceConfig): ONVIFReceiver

Defined in api/receiver.ts:5

Parameters:

Name	Type
config	IDeviceConfig

Returns: ONVIFReceiver

Properties

Private config

• config: IDeviceConfig

Defined in api/receiver.ts:6

Methods

ConfigureReceiver

▸ ConfigureReceiver(ReceiverToken: ReferenceToken, Configuration: ReceiverConfiguration): Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

Defined in api/receiver.ts:152

Configures an existing receiver. This operation is mandatory.

Parameters:

Name	Type
ReceiverToken	ReferenceToken
Configuration	ReceiverConfiguration

Returns: Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

---

CreateReceiver

▸ CreateReceiver(Configuration: ReceiverConfiguration): Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

Defined in api/receiver.ts:132

Creates a new receiver. This operation is mandatory, although the service may raise a fault if the receiver cannot be created.

Parameters:

Name	Type
Configuration	ReceiverConfiguration

Returns: Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

---

DeleteReceiver

▸ DeleteReceiver(ReceiverToken: ReferenceToken): Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

Defined in api/receiver.ts:143

Deletes an existing receiver. A receiver may be deleted only if it is not currently in use; otherwise a fault shall be raised. This operation is mandatory.

Parameters:

Name	Type
ReceiverToken	ReferenceToken

Returns: Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

---

GetReceiver

▸ GetReceiver(ReceiverToken: ReferenceToken): Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

Defined in api/receiver.ts:122

Retrieves the details of a specific receiver. This operation is mandatory.

Parameters:

Name	Type
ReceiverToken	ReferenceToken

Returns: Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

---

GetReceiverState

▸ GetReceiverState(ReceiverToken: ReferenceToken): Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

Defined in api/receiver.ts:173

Determines whether the receiver is currently disconnected, connected or attempting to connect. This operation is mandatory.

Parameters:

Name	Type
ReceiverToken	ReferenceToken

Returns: Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

---

GetReceivers

▸ GetReceivers(): Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

Defined in api/receiver.ts:113

Lists all receivers currently present on a device. This operation is mandatory.

Returns: Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

---

GetServiceCapabilities

▸ GetServiceCapabilities(): Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

Defined in api/receiver.ts:104

Returns the capabilities of the receiver service. The result is returned in a typed answer.

Returns: Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

---

SetReceiverMode

▸ SetReceiverMode(ReceiverToken: ReferenceToken, Mode: ReceiverMode): Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

Defined in api/receiver.ts:162

Sets the mode of the receiver without affecting the rest of its configuration. This operation is mandatory.

Parameters:

Name	Type
ReceiverToken	ReferenceToken
Mode	ReceiverMode

Returns: Observable‹IResult‹IResultStructure‹any›, ITransportPayoad››

---

Static ConfigureReceiver

▸ ConfigureReceiver(ReceiverToken: ReferenceToken, Configuration: ReceiverConfiguration): IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

Defined in api/receiver.ts:70

Configures an existing receiver. This operation is mandatory.

Parameters:

Name	Type
ReceiverToken	ReferenceToken
Configuration	ReceiverConfiguration

Returns: IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

---

Static CreateReceiver

▸ CreateReceiver(Configuration: ReceiverConfiguration): IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

Defined in api/receiver.ts:46

Creates a new receiver. This operation is mandatory, although the service may raise a fault if the receiver cannot be created.

Parameters:

Name	Type
Configuration	ReceiverConfiguration

Returns: IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

---

Static DeleteReceiver

▸ DeleteReceiver(ReceiverToken: ReferenceToken): IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

Defined in api/receiver.ts:59

Deletes an existing receiver. A receiver may be deleted only if it is not currently in use; otherwise a fault shall be raised. This operation is mandatory.

Parameters:

Name	Type
ReceiverToken	ReferenceToken

Returns: IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

---

Static GetReceiver

▸ GetReceiver(ReceiverToken: ReferenceToken): IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

Defined in api/receiver.ts:34

Retrieves the details of a specific receiver. This operation is mandatory.

Parameters:

Name	Type
ReceiverToken	ReferenceToken

Returns: IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

---

Static GetReceiverState

▸ GetReceiverState(ReceiverToken: ReferenceToken): IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

Defined in api/receiver.ts:95

Determines whether the receiver is currently disconnected, connected or attempting to connect. This operation is mandatory.

Parameters:

Name	Type
ReceiverToken	ReferenceToken

Returns: IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

---

Static GetReceivers

▸ GetReceivers(): IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

Defined in api/receiver.ts:23

Lists all receivers currently present on a device. This operation is mandatory.

Returns: IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

---

Static GetServiceCapabilities

▸ GetServiceCapabilities(): IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

Defined in api/receiver.ts:12

Returns the capabilities of the receiver service. The result is returned in a typed answer.

Returns: IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

---

Static SetReceiverMode

▸ SetReceiverMode(ReceiverToken: ReferenceToken, Mode: ReceiverMode): IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››

Defined in api/receiver.ts:82

Sets the mode of the receiver without affecting the rest of its configuration. This operation is mandatory.

Parameters:

Name	Type
ReceiverToken	ReferenceToken
Mode	ReceiverMode

Returns: IReader‹IDeviceConfig, Observable‹IResult‹IResultStructure‹any›, ITransportPayoad›››