onvif
    Preparing search index...

    Interface Display

    Display service — video output layout and pane configurations.

    import { Onvif } from 'onvif';

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

    const outputs = await onvif.deviceIO.getVideoOutputs();
    const videoOutput = outputs[0]!.token;

    const options = await onvif.display.getDisplayOptions({ videoOutput });
    const layout = await onvif.display.getLayout({ videoOutput });
    const panes = await onvif.display.getPaneConfigurations({ videoOutput });
    console.log(options, layout, panes.map((p) => p.paneName ?? p.token));

    if (panes[0]) {
      await onvif.display.setPaneConfiguration({
        videoOutput,
        paneConfiguration: { ...panes[0], paneName: panes[0].paneName ?? 'Main' },
      });
    }
    interface Display {
        onvif: Onvif;
        service: keyof OnvifServices;
        xmlns: string;
        createPaneConfiguration(options: CreatePaneConfiguration): Promise<string>;
        deletePaneConfiguration(options: DeletePaneConfiguration): Promise<void>;
        getDisplayOptions(
            options: GetDisplayOptions,
        ): Promise<GetDisplayOptionsResponse>;
        getLayout(options: GetLayout): Promise<any>;
        getPaneConfiguration(
            options: GetPaneConfiguration,
        ): Promise<PaneConfiguration>;
        getPaneConfigurations(
            options: GetPaneConfigurations,
        ): Promise<PaneConfiguration[]>;
        getServiceCapabilities(): Promise<Capabilities>;
        request<T = any>(
            body: OnvifSoapBody,
            options?: LineraseOptions,
        ): Promise<T>;
        setLayout(options: SetLayout): Promise<void>;
        setPaneConfiguration(options: SetPaneConfiguration): Promise<void>;
        setPaneConfigurations(options: SetPaneConfigurations): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    onvif service xmlns
    createPaneConfiguration deletePaneConfiguration getDisplayOptions getLayout getPaneConfiguration getPaneConfigurations getServiceCapabilities request setLayout setPaneConfiguration setPaneConfigurations
    onvif: Onvif
    service: keyof OnvifServices
    xmlns: string

    • Returns the current layout of a video output.

      Parameters

      Returns Promise<any>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods