@ohos.distributedHardware.hardwareManager (Distributed Hardware Management) (System API)

The HardwareManager module provides the capability of controlling distributed hardware, including pausing, resuming, and stopping the distributed hardware service on the controlled device.

NOTE

The initial APIs of this module are supported since API version 11. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The APIs provided by this module are system APIs.

Modules to Import

import hardwareManager from '@ohos.distributedHardware.hardwareManager';

HardwareDescriptor

Represents the distributed hardware information.

System capability: SystemCapability.DistributedHardware.DistributedHardwareFWK

DistributedHardwareType

Enumerates the types of the distributed hardware.

System capability: SystemCapability.DistributedHardware.DistributedHardwareFWK

DistributedHardwareErrorCode

Enumerates the error codes used for the distributed hardware.

System capability: SystemCapability.DistributedHardware.DistributedHardwareFWK

hardwareManager.pauseDistributedHardware

pauseDistributedHardware(description: HardwareDescriptor): Promise<void>

Pauses the distributed hardware service on the controlled device. This API uses a promise to return the result.

Required permissions: ohos.permission.ACCESS_DISTRIBUTED_HARDWARE

System capability: SystemCapability.DistributedHardware.DistributedHardwareFWK

Parameters

Return value

Error codes

Example

import hardwareManager from '@ohos.distributedHardware.hardwareManager';
import { BusinessError } from '@ohos.base';

try {
  let description: hardwareManager.HardwareDescriptor = {
    type: 1,
    srcNetworkId: '1111'
  };
  hardwareManager.pauseDistributedHardware(description).then(() => {
    console.log('pause distributed hardware successfully');
  }).catch((error: BusinessError) => {
    console.error('pause distributed hardware failed, cause:' + error);
  })
  console.log('pause distributed hardware successfully');
} catch (error) {
  console.error('pause distributed hardware failed:' + error);
}

hardwareManager.resumeDistributedHardware

resumeDistributedHardware(description: HardwareDescriptor): Promise<void>

Resumes the distributed hardware service on the controlled device. This API uses a promise to return the result.

Required permissions: ohos.permission.ACCESS_DISTRIBUTED_HARDWARE

System capability: SystemCapability.DistributedHardware.DistributedHardwareFWK

Parameters

Return value

Error codes

Example

import hardwareManager from '@ohos.distributedHardware.hardwareManager';
import { BusinessError } from '@ohos.base';

try {
  let description: hardwareManager.HardwareDescriptor = {
    type: 1,
    srcNetworkId: '1111'
  };
  hardwareManager.resumeDistributedHardware(description).then(() => {
    console.log('resume distributed hardware successfully');
  }).catch((error: BusinessError) => {
    console.error('resume distributed hardware failed, cause:' + error);
  })
  console.log('resume distributed hardware successfully');
} catch (error) {
  console.error('resume distributed hardware failed:' + error);
}

hardwareManager.stopDistributedHardware

stopDistributedHardware(description: HardwareDescriptor): Promise<void>

Stops the distributed hardware service on the controlled device. This API uses a promise to return the result.

Required permissions: ohos.permission.ACCESS_DISTRIBUTED_HARDWARE

System capability: SystemCapability.DistributedHardware.DistributedHardwareFWK

Parameters

Return value

Error codes

Example

import hardwareManager from '@ohos.distributedHardware.hardwareManager';
import { BusinessError } from '@ohos.base';

try {
  let description: hardwareManager.HardwareDescriptor = {
    type: 1,
    srcNetworkId: '1111'
  };
  hardwareManager.stopDistributedHardware(description).then(() => {
    console.log('stop distributed hardware successfully');
  }).catch((error: BusinessError) => {
    console.error('stop distributed hardware failed, cause:' + error);
  })
  console.log('stop distributed hardware successfully');
} catch (error) {
  console.error('stop distributed hardware failed:' + error);
}