Device.get_option()
Info | Value |
---|---|
Package | mvnc |
Module | mvncapi |
Version | 2.0 |
See also | Device, DeviceOption, Device.set_option() |
Overview
This method returns the value of an option for the Device. The available options and possible values can be found in the DeviceOption enumeration.
Syntax
value = device.get_option(option)
Parameters
Parameter | Type | Description |
---|---|---|
option | int | A member of the DeviceOption enumeration that specifies which option value to get. |
Return
value
The value for the specified option. The value type depends on the option specified. See the DeviceOption enumeration for the type that corresponds to each option.
Raises
Exception with a Status.INVALID_PARAMETERS code if an invalid option is passed or Exception with a status code from Status if underlying function calls return a status other than Status.OK.
Notes
- The DeviceState must be CREATED or OPENED.
Example
from mvnc import mvncapi
# Get a list of valid device identifiers
device_list = mvncapi.enumerate_devices()
# Create a Device instance for the first device found
device = mvncapi.Device(device_list[0])
# Get the device name and output to console
print(device.get_option(mvncapi.DeviceOption.RO_DEVICE_NAME))
# Destroy the device handle
device.destroy()