onvif
    Preparing search index...

    Interface Messages

    interface Messages {
        data?: ItemListDescription;
        extension?: MessageDescriptionExtension;
        isProperty?: boolean;
        key?: ItemListDescription;
        parentTopic: string;
        source?: ItemListDescription;
    }

    Hierarchy (View Summary)

    Index
    data? extension? isProperty? key? parentTopic source?
    data?: ItemListDescription

    Describes the payload of the message.

    extension?: MessageDescriptionExtension
    isProperty?: boolean

    Must be set to true when the described Message relates to a property. An alternative term of "property" is a "state" in contrast to a pure event, which contains relevant information for only a single point in time.Default is false.

    key?: ItemListDescription

    Describes optional message payload parameters that may be used as key. E.g. object IDs of tracked objects are conveyed as key.

    parentTopic: string

    The topic of the message. For historical reason the element is named ParentTopic, but the full topic is expected.

    source?: ItemListDescription

    Set of tokens producing this message. The list may only contain SimpleItemDescription items. The set of tokens identify the component within the WS-Endpoint, which is responsible for the producing the message. For analytics events the token set shall include the VideoSourceConfigurationToken, the VideoAnalyticsConfigurationToken and the name of the analytics module or rule.

    Settings
    Member Visibility

    On This Page
    Properties