/** * Logging level for logging to the native log. * For internal use only! */ export declare const enum AddonLogSeverity { none = 0, fatal = 1, error = 2, warning = 3, info = 4, debug = 5, verbose = 6 }; /** * Native log configuration. * For internal use only! */ export declare interface NativeAddonLogConfig { maxSeverity: AddonLogSeverity; maxSeverityString: AddonLogSeverity; configuredLogPath: string; }; export enum HidWorkState { /** Setting Standard HID or YL HID is not supported */ NOT_SUPPORTED = 0, /** Use standard HID as specified in the HID specification from usb.org. */ STD_HID = 1, /** Use YL HID as specified by YL. */ YL_HID = 2 } export enum DeviceBtnType { Undefined = 0, OffHook, Mute, Flash, Hold, Redial, Line, SpeakerPhone, Send, Reject, SpeedDial, VoiceMail, LedRinger, LineBusyTone, Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8, Key9, KeyStar, KeyPound, KeyDelete, KeyVolumeUp, KeyVolumeDown, KeyFastForward, KeyRewind, KeyScanNextTrack, KeyScanPreviousTrack, KeyStop, KeyPlayPause } export enum ReturnCode { Return_Ok = 0,// "Success") Device_Unknown, //"The device is not known") Device_Invalid,// "The device is invalid") Not_Supported, //"The device is not supported") Return_ParameterFail,// "One or more parameters are wrong") ProtectedSetting_Write,// "The setting you are attempting to write is protected") No_Information,// "No info available") NetworkRequest_Fail,// "Network failure") Device_WriteFail, //"Failed writing to the device") Device_ReadFails,// "Failed reading from the device") No_FactorySupported, //"Factory reset is not supported or allowed") System_Error,// "System error") Device_BadState,// "The device is in a bad state") FileWrite_Fail, //"Failed writing to file") File_AlreadyExists,// "The file already exists") File_Not_Accessible, //"The file is not accessible") Firmware_UpToDate, //"Firmware is up-to-date") Firmware_Available,// "Firmware is available") Return_Async, //"Asynch operation has started in the background") Invalid_Authorization,// "Authorization failure") Device_AlreadyConnected,// "The device is already connected") Device_NotConnected,// "The device is not connected") CannotClear_DeviceConnected,// "Unable to clear, the device has an active connection") Device_Rebooted,// "The device rebooted") Upload_AlreadyInProgress,// "Upload is already in progress") Download_AlreadyInProgress,// "Download is already in progress") Sdk_TooOldForFwUpdate, //"The Yealink SDK is too old to update the selected firmware") No_OtaUpdateSupport,// "Firmware update through OTA is not supported for this device") Non_Device_Detection_disabled,// "Non Yealink device detection is disabled") Preset_Count_Limit, // "The number of preset reaches limit" Preset_Not_Exist, // "The preset index not exist" Preset_Apply_Time_Out, // "The camera cannot rotate to the specified position, check position timeout timeout" Operation_Fail_SmartTracking_Enabled, // "Operation failed because smart tracking is enabled" Camera_Not_Ready, // "Camera not ready, operation not supported" Other_Error, NUMBER_OF_RETURNCODES } export enum ErrorStatus { NoError = 0,// "No Error") SSLError,// "SSL Handshake failed. Please contact your administrator") CertError,// "Failed to Authenticate Server Certificate. Please contact your administrator") NetworkError,// "Unable to download the files. Please check Internet connection and reconnect the device") DownloadError,// "Setting files download failed. Please contact your administrator") ParseError, //"Unable to retrieve device settings. Please reconnect device") OtherError, //"Unknown error. Please contact your administrator") DeviceInfoError, //"Unable to retrieve device information. Please reconnect device") FileNotAccessible,// "File is not accessible") FileNotCompatible, //"File is not compatible for the device") Device_NotFound,// "The specified device is not found") Parameter_fail,// "Incorrect parameters") Authorization_failed,// "Authorization failed") FileNotAvailable,// "Files are not available for the device. Please check internet connection and reconnect the device") ConfigParseError,// "Config XML parse error") SetSettings_Fail, //"Error in applying settings") Device_Reboot, //"Device will reboot due to change in the settings") Device_ReadFail,// "Unable to read settings from the device") Device_NotReady, //"The device is not ready") FilePartiallyCompatible,// "Partial Settings loaded") SdkTooOldForFwUpdateError, //"The Yealink SDK is too old to update the selected firmware") NUMBER_OF_YEALINK_ERRORCODES } export enum DeviceConnectionType { USB = 0, BT } export enum LogEventType { Log_Upload = 0, Log_Export } export interface DateTime { sec: number, // Seconds, range is [0-59]. min: number, // Minutes, range is [0-59]. hour: number, // Hours, range is [0-23]. mday: number, // Day of month, range is [1-31]. mon: number, // Month, range is [0-11]. year: number, // Year, range is [0-n], where 0 is 1900CE. wday: number // Day of week, range is [0-6] where 0 is Sunday. } export enum DeviceFeature { FeaFactoryReset = 1000, FeaReboot, FeaLogging, FeaSetDateTime, FeaBluetooth, FeaRemoteMMI, FeaBattery, FeaContact, FeaUploadRingtone, FeaPlayRingtone, FeaBusyLight, FeaExportAudio, FeaSettings, FeaCameraPTZ, FeaCameraPreset, FeaCameraFaceDetection, FeaCameraSmartTracking, FeaRccMultiCall, } export enum EqualizerMode { Equalizer_Normal, Equalizer_Bass, Equalizer_Treble } export enum WizardModes { No_Wizard, Normal_Wizard, } /** * Device description structure, identifies attached devices. */ export interface DeviceInfo { deviceId: number; // Device identifier, used for most API calls to identify the device to operate on. productId: number; // Product identifier, used for identifying the type of product. vendorId: number; // Vendor identifier, used for identifying the vendor. Yealink vendor ID is 0x6993. deviceName: string; devicePath: string; parentInstanceId: string; errStatus: ErrorStatus; isDongle: boolean; dongleName: string; variant: string; serialNumber: string; isInFirmwareUpdateMode: boolean; //if in FireWareUpdateMode the sdk interface does not work, please not invoke deviceconnection: DeviceConnectionType; connectionId: number; parentDeviceId: number; } export enum BusylightStatus { BUSYLIGHT_UNKNOWN = 0, BUSYLIGHT_RING, BUSYLIGHT_TALKING, BUSYLIGHT_HOLD, BUSYLIGHT_MUTE, BUSYLIGHT_DIALINNG, BUSYLIGHT_ONLINE, BUSYLIGHT_OFFLINE, BUSYLIGHT_LEFT, BUSYLIGHT_BUSY, BUSYLIGHT_NOT_DISTURB, BUSYLIGHT_OFFWORK, } export enum AudioModes { AM_HANDFREE, AM_HEADSET, } export interface ContactInfo { name: string; number: string; } export interface ContactInfoList { nCount: number; listContact: Array } export enum UploadEventStatus { UploadInProgress = 0, UploadCompleted = 1, UploadError = 2 } export interface ConfigParamsCloud { blockNetworkAccess?: boolean, } export enum CallAction { CALL_ACTION_ACCEPT = 1, // accept call CALL_ACTION_TERMINATE = 2, // terminate call CALL_ACTION_HOLD = 3, // hold call CALL_ACTION_RESUME = 4, // resume call CALL_ACTION_REJECT = 5, // reject call CALL_ACTION_CALL_OUT = 6, // call out CALL_ACTION_ENTER_DIAL = 7, // enter dial CALL_ACTION_MUTE = 8, // mute call CALL_ACTION_UNMUTE = 9, // unmute call CALL_ACTION_DTMF = 10, // dtmf CALL_ACTION_REDIAL = 11, // redial call } export enum CallReturn { CALL_RETURN_SUCCESS = 0, // success CALL_RETURN_NOT_SUPPORT_RCC = 1, // device not support remote call control CALL_RETURN_CALL_NOT_EXIST = 2, // the operating call not exist CALL_RETURN_CALL_ALREADY_EXIST = 3, // the operating call exist CALL_RETURN_CID_ALLOC_FAILED = 4, // sdk's call id allocate failed CALL_RETURN_CALL_SYNC_FAILED = 5, // failed to sync call state to device CALL_RETURN_USER_CID_UNEXPECT = 6, // user call id unexpected CALL_RETURN_CALL_COUNT_LIMIT = 7, // count of call exceed the limit CALL_RETURN_RCC_DISABLE_BY_YUC = 8, // rcc is disabled by YUC, if you want to use it, please enable it in YUC CALL_RETRUN_OPERATION_NOT_SUPPORT = 9, // device or protocol does not support this operation, you can ignore and continue next operation CALL_RETURN_OTHER = 9999, // other fail }