onvif
    Preparing search index...

    Interface Capabilities

    The service capabilities reflect optional functionality of a service. The information is static and does not change during device operation. The following capabilities are available:

    interface Capabilities {
        clientSuppliedTokenSupported?: boolean;
        extendedRecurrenceSupported: boolean;
        maxDaysInSpecialDayGroup: number;
        maxLimit: number;
        maxSchedules: number;
        maxSpecialDayGroups: number;
        maxSpecialDaysSchedules: number;
        maxTimePeriodsPerDay: number;
        specialDaysSupported: boolean;
        stateReportingSupported: boolean;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index
    clientSuppliedTokenSupported? extendedRecurrenceSupported maxDaysInSpecialDayGroup maxLimit maxSchedules maxSpecialDayGroups maxSpecialDaysSchedules maxTimePeriodsPerDay specialDaysSupported stateReportingSupported
    clientSuppliedTokenSupported?: boolean

    Indicates that the client is allowed to supply the token when creating schedules and special day groups. To enable the use of the commands SetSchedule and SetSpecialDayGroup, the value must be set to true.

    extendedRecurrenceSupported: boolean

    For schedules: If this capability is supported, then all iCalendar recurrence types shall be supported by the device. The device shall also support the start and end dates (or iCalendar occurrence count) in recurring events (see iCalendar examples in section 3). If this capability is not supported, then only the weekly iCalendar recurrence type shall be supported. Non-recurring events and other recurring types are not supported. The device shall only accept a start date with the year ‘1970’ (the month and day is needed to reflect the week day of the recurrence) and will not accept an occurrence count (or iCalendar until date) in recurring events. For special days (only applicable if SpecialDaysSupported is set to true): If this capability is supported, then all iCalendar recurrence types shall be supported by the device. The device shall also support the start and end dates (or occurrence count) in recurring events. If this capability is not supported, then only non-recurring special days are supported.

    maxDaysInSpecialDayGroup: number

    Indicates the maximum number of days per ‘SpecialDayGroup’ entity the device supports. The device shall support at least one day per ‘SpecialDayGroup’ entity.

    maxLimit: number

    The maximum number of entries returned by a single Get<Entity>List or Get<Entity> request. The device shall never return more than this number of entities in a single response.

    maxSchedules: number

    Indicates the maximum number of schedules the device supports. The device shall support at least one schedule.

    maxSpecialDayGroups: number

    Indicates the maximum number of special day group entities the device supports. The device shall support at least one ‘SpecialDayGroup’ entity.

    maxSpecialDaysSchedules: number

    Indicates the maximum number of ‘SpecialDaysSchedule’ entities referred by a schedule that the device supports.

    maxTimePeriodsPerDay: number

    Indicates the maximum number of time periods per day the device supports in a schedule including special days schedule. The device shall support at least one time period per day.

    specialDaysSupported: boolean

    If this capability is supported, then the device shall support special days.

    stateReportingSupported: boolean

    If this capability is set to true, the device shall implement the GetScheduleState command, and shall notify subscribing clients whenever schedules become active or inactive.

    Settings
    Member Visibility

    On This Page
    Properties