onvif
    Preparing search index...

    Interface Schedule

    Schedule service

    import { Onvif } from 'onvif';

    const onvif = new Onvif({ hostname: '192.168.1.13', username: 'admin', password: 'admin' });
    await onvif.connect();

    const caps = await onvif.schedule.getServiceCapabilities();
    const list = await onvif.schedule.getScheduleInfoList();
    const groups = await onvif.schedule.getSpecialDayGroupInfoList();
    const token = list.scheduleInfo![0].token;
    const schedules = await onvif.schedule.getSchedules({ token: [token] });
    const state = await onvif.schedule.getScheduleState({ token });
    console.log(caps, schedules[0]?.standard, groups.specialDayGroupInfo?.length, state.active);
    interface Schedule {
        onvif: Onvif;
        service: keyof OnvifServices;
        xmlns: string;
        createSchedule(options: CreateSchedule): Promise<string>;
        createSpecialDayGroup(options: CreateSpecialDayGroup): Promise<string>;
        deleteSchedule(options: DeleteSchedule): Promise<void>;
        deleteSpecialDayGroup(options: DeleteSpecialDayGroup): Promise<void>;
        getScheduleInfo(options: GetScheduleInfo): Promise<ScheduleInfo[]>;
        getScheduleInfoList(
            options?: GetScheduleInfoList,
        ): Promise<GetScheduleInfoListResponse>;
        getScheduleList(
            options?: GetScheduleList,
        ): Promise<GetScheduleListResponse>;
        getSchedules(options: GetSchedules): Promise<Schedule[]>;
        getScheduleState(options: GetScheduleState): Promise<ScheduleState>;
        getServiceCapabilities(): Promise<Capabilities>;
        getSpecialDayGroupInfo(
            options: GetSpecialDayGroupInfo,
        ): Promise<SpecialDayGroupInfo[]>;
        getSpecialDayGroupInfoList(
            options?: GetSpecialDayGroupInfoList,
        ): Promise<GetSpecialDayGroupInfoListResponse>;
        getSpecialDayGroupList(
            options?: GetSpecialDayGroupList,
        ): Promise<GetSpecialDayGroupListResponse>;
        getSpecialDayGroups(
            options: GetSpecialDayGroups,
        ): Promise<SpecialDayGroup[]>;
        modifySchedule(options: ModifySchedule): Promise<void>;
        modifySpecialDayGroup(options: ModifySpecialDayGroup): Promise<void>;
        request<T = any>(
            body: OnvifSoapBody,
            options?: LineraseOptions,
        ): Promise<T>;
        setSchedule(options: SetSchedule): Promise<void>;
        setSpecialDayGroup(options: SetSpecialDayGroup): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    onvif service xmlns
    createSchedule createSpecialDayGroup deleteSchedule deleteSpecialDayGroup getScheduleInfo getScheduleInfoList getScheduleList getSchedules getScheduleState getServiceCapabilities getSpecialDayGroupInfo getSpecialDayGroupInfoList getSpecialDayGroupList getSpecialDayGroups modifySchedule modifySpecialDayGroup request setSchedule setSpecialDayGroup
    onvif: Onvif
    service: keyof OnvifServices
    xmlns: string

    • Creates or replaces a schedule (requires ClientSuppliedTokenSupported).

      Parameters

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods