Skip to content

Receiver

Receiver service implementation.

Receiver

Bases: ONVIFService

0.0.1 2.0

Receiver service client.

Property Details
First introduced ONVIF 2.0 (November 2010)
Binding name ReceiverBinding (ver10/receiver.wsdl)
Operations receiver.wsdl
Spec Receiver
Data Format Streaming

GetServiceCapabilities 

GetServiceCapabilities()

Returns the capabilities of the receiver service.

The result is returned in a typed answer.

Output
  • Capabilities [Capabilities]
    The capabilities for the receiver service is returned in the Capabilities element.
    • RTP_Multicast - optional; [boolean]
      Indicates that the device can receive RTP multicast streams.
    • RTP_TCP - optional; [boolean]
      Indicates that the device can receive RTP/TCP streams
    • RTP_RTSP_TCP - optional; [boolean]
      Indicates that the device can receive RTP/RTSP/TCP streams.
    • SupportedReceivers - required; [int]
      The maximum number of receivers supported by the device.
    • MaximumRTSPURILength - optional; [int]
      The maximum allowed length for RTSP URIs (Minimum and default value is 128 octet).

GetReceivers 

GetReceivers()

Lists all receivers currently present on a device.

This operation is mandatory.

Output
  • Receivers - optional, unbounded; [Receiver]
    A list of all receivers that currently exist on the device.
    • Token [ReferenceToken]
      Unique identifier of the receiver.
      Maximum length: 64
    • Configuration [ReceiverConfiguration]
      Describes the configuration of the receiver.
      • Mode [ReceiverMode]
        The following connection modes are defined:
        Enum Value Enum Description
        AutoConnect The receiver connects on demand, as required by consumers of the media streams.
        AlwaysConnect The receiver attempts to maintain a persistent connection to the configured endpoint.
        NeverConnect The receiver does not attempt to connect.
        Unknown This case should never happen.
      • MediaUri [anyURI]
        Details of the URI to which the receiver should connect.
      • StreamSetup [StreamSetup]
        Stream connection parameters.
        • Stream [StreamType]
          Defines if a multicast or unicast stream is requested.
          Enum Value Enum Description
          RTP-Unicast —
          RTP-Multicast —
        • Transport [Transport]
          • Protocol [TransportProtocol]
            Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP.
            Enum Value Enum Description
            UDP —
            TCP This value is deprecated.
            RTSP —
            HTTP —
          • Tunnel - optional; [complexType]
            Deprecated: optional element to describe further tunnel options.

GetReceiver 

GetReceiver(ReceiverToken)

Retrieves the details of a specific receiver.

This operation is mandatory.

Input
  • ReceiverToken [ReferenceToken]
    The token of the receiver to be retrieved.
    Maximum length: 64
Output
  • Receiver [Receiver]
    The details of the receiver.
    • Token [ReferenceToken]
      Unique identifier of the receiver.
      Maximum length: 64
    • Configuration [ReceiverConfiguration]
      Describes the configuration of the receiver.
      • Mode [ReceiverMode]
        The following connection modes are defined:
        Enum Value Enum Description
        AutoConnect The receiver connects on demand, as required by consumers of the media streams.
        AlwaysConnect The receiver attempts to maintain a persistent connection to the configured endpoint.
        NeverConnect The receiver does not attempt to connect.
        Unknown This case should never happen.
      • MediaUri [anyURI]
        Details of the URI to which the receiver should connect.
      • StreamSetup [StreamSetup]
        Stream connection parameters.
        • Stream [StreamType]
          Defines if a multicast or unicast stream is requested.
          Enum Value Enum Description
          RTP-Unicast —
          RTP-Multicast —
        • Transport [Transport]
          • Protocol [TransportProtocol]
            Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP.
            Enum Value Enum Description
            UDP —
            TCP This value is deprecated.
            RTSP —
            HTTP —
          • Tunnel - optional; [complexType]
            Deprecated: optional element to describe further tunnel options.

CreateReceiver 

CreateReceiver(Configuration)

Creates a new receiver.

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

Input
  • Configuration [ReceiverConfiguration]
    The initial configuration for the new receiver.
    • Mode [ReceiverMode]
      The following connection modes are defined:
      Enum Value Enum Description
      AutoConnect The receiver connects on demand, as required by consumers of the media streams.
      AlwaysConnect The receiver attempts to maintain a persistent connection to the configured endpoint.
      NeverConnect The receiver does not attempt to connect.
      Unknown This case should never happen.
    • MediaUri [anyURI]
      Details of the URI to which the receiver should connect.
    • StreamSetup [StreamSetup]
      Stream connection parameters.
      • Stream [StreamType]
        Defines if a multicast or unicast stream is requested.
        Enum Value Enum Description
        RTP-Unicast —
        RTP-Multicast —
      • Transport [Transport]
        • Protocol [TransportProtocol]
          Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP.
          Enum Value Enum Description
          UDP —
          TCP This value is deprecated.
          RTSP —
          HTTP —
        • Tunnel - optional; [complexType]
          Deprecated: optional element to describe further tunnel options.
Output
  • Receiver [Receiver]
    The details of the receiver that was created.
    • Token [ReferenceToken]
      Unique identifier of the receiver.
      Maximum length: 64
    • Configuration [ReceiverConfiguration]
      Describes the configuration of the receiver.
      • Mode [ReceiverMode]
        The following connection modes are defined:
        Enum Value Enum Description
        AutoConnect The receiver connects on demand, as required by consumers of the media streams.
        AlwaysConnect The receiver attempts to maintain a persistent connection to the configured endpoint.
        NeverConnect The receiver does not attempt to connect.
        Unknown This case should never happen.
      • MediaUri [anyURI]
        Details of the URI to which the receiver should connect.
      • StreamSetup [StreamSetup]
        Stream connection parameters.
        • Stream [StreamType]
          Defines if a multicast or unicast stream is requested.
          Enum Value Enum Description
          RTP-Unicast —
          RTP-Multicast —
        • Transport [Transport]
          • Protocol [TransportProtocol]
            Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP.
            Enum Value Enum Description
            UDP —
            TCP This value is deprecated.
            RTSP —
            HTTP —
          • Tunnel - optional; [complexType]
            Deprecated: optional element to describe further tunnel options.

DeleteReceiver 

DeleteReceiver(ReceiverToken)

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.

Input
  • ReceiverToken [ReferenceToken]
    The token of the receiver to be deleted.
    Maximum length: 64

ConfigureReceiver 

ConfigureReceiver(ReceiverToken, Configuration)

Configures an existing receiver.

This operation is mandatory.

Input
  • ReceiverToken [ReferenceToken]
    The token of the receiver to be configured.
    Maximum length: 64
  • Configuration [ReceiverConfiguration]
    The new configuration for the receiver.
    • Mode [ReceiverMode]
      The following connection modes are defined:
      Enum Value Enum Description
      AutoConnect The receiver connects on demand, as required by consumers of the media streams.
      AlwaysConnect The receiver attempts to maintain a persistent connection to the configured endpoint.
      NeverConnect The receiver does not attempt to connect.
      Unknown This case should never happen.
    • MediaUri [anyURI]
      Details of the URI to which the receiver should connect.
    • StreamSetup [StreamSetup]
      Stream connection parameters.
      • Stream [StreamType]
        Defines if a multicast or unicast stream is requested.
        Enum Value Enum Description
        RTP-Unicast —
        RTP-Multicast —
      • Transport [Transport]
        • Protocol [TransportProtocol]
          Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP.
          Enum Value Enum Description
          UDP —
          TCP This value is deprecated.
          RTSP —
          HTTP —
        • Tunnel - optional; [complexType]
          Deprecated: optional element to describe further tunnel options.

SetReceiverMode 

SetReceiverMode(ReceiverToken, Mode)

Sets the mode of the receiver without affecting the rest of its configuration.

This operation is mandatory.

Input
  • ReceiverToken [ReferenceToken]
    The token of the receiver to be changed.
    Maximum length: 64
  • Mode [ReceiverMode]
    The new receiver mode. Options available are:
    Enum Value Enum Description
    AutoConnect The receiver connects on demand, as required by consumers of the media streams.
    AlwaysConnect The receiver attempts to maintain a persistent connection to the configured endpoint.
    NeverConnect The receiver does not attempt to connect.
    Unknown This case should never happen.

GetReceiverState 

GetReceiverState(ReceiverToken)

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

This operation is mandatory.

Input
  • ReceiverToken [ReferenceToken]
    The token of the receiver to be queried.
    Maximum length: 64
Output
  • ReceiverState [ReceiverStateInformation]
    Description of the current receiver state.
    • State [ReceiverState]
      The connection state of the receiver may have one of the following states:
      Enum Value Enum Description
      NotConnected The receiver is not connected.
      Connecting The receiver is attempting to connect.
      Connected The receiver is connected.
      Unknown This case should never happen.
    • AutoCreated [boolean]
      Indicates whether or not the receiver was created automatically.