# PluginLID_Definition Struct Reference

`#include <lidplugin.h>`

## Data Fields

unsigned int | apiVersion
time_t | timestamp
const char * | name
const char * | description
const char * | manufacturer
const char * | model
const char * | revision
const char * | manufacturerEmail
const char * | manufacturerURL
const char * | author
const char * | authorEmail
const char * | authorURL
const char * | copyright
const char * | license
const char * | version
const void * | userData
void *(* | Create )(const struct PluginLID_Definition *definition)
void(* | Destroy )(const struct PluginLID_Definition *definition, void *context)
PluginLID_Errors(* | GetDeviceName )(void *context, unsigned index, char *name, unsigned size)
PluginLID_Errors(* | Open )(void *context, const char *device)
PluginLID_Errors(* | Close )(void *context)
PluginLID_Errors(* | GetLineCount )(void *context, unsigned *count)
PluginLID_Errors(* | IsLineTerminal )(void *context, unsigned line, PluginLID_Boolean *isTerminal)
PluginLID_Errors(* | IsLinePresent )(void *context, unsigned line, PluginLID_Boolean forceTest, PluginLID_Boolean *present)
PluginLID_Errors(* | IsLineOffHook )(void *context, unsigned line, PluginLID_Boolean *offHook)
PluginLID_Errors(* | SetLineOffHook )(void *context, unsigned line, PluginLID_Boolean newState)
PluginLID_Errors(* | HookFlash )(void *context, unsigned line, unsigned flashTime)
PluginLID_Errors(* | HasHookFlash )(void *context, unsigned line, PluginLID_Boolean *flashed)
PluginLID_Errors(* | IsLineRinging )(void *context, unsigned line, unsigned long *cadence)
PluginLID_Errors(* | RingLine )(void *context, unsigned line, unsigned nCadence, const unsigned *pattern, unsigned frequency)
PluginLID_Errors(* | IsLineDisconnected )(void *context, unsigned line, PluginLID_Boolean checkForWink, PluginLID_Boolean *disconnected)
PluginLID_Errors(* | SetLineToLineDirect )(void *context, unsigned line1, unsigned line2, PluginLID_Boolean connect)
PluginLID_Errors(* | IsLineToLineDirect )(void *context, unsigned line1, unsigned line2, PluginLID_Boolean *connected)
PluginLID_Errors(* | GetSupportedFormat )(void *context, unsigned index, char *mediaFormat, unsigned size)
PluginLID_Errors(* | SetReadFormat )(void *context, unsigned line, const char *mediaFormat)
PluginLID_Errors(* | SetWriteFormat )(void *context, unsigned line, const char *mediaFormat)
PluginLID_Errors(* | GetReadFormat )(void *context, unsigned line, char *mediaFormat, unsigned size)
PluginLID_Errors(* | GetWriteFormat )(void *context, unsigned line, char *mediaFormat, unsigned size)
PluginLID_Errors(* | StopReading )(void *context, unsigned line)
PluginLID_Errors(* | StopWriting )(void *context, unsigned line)
PluginLID_Errors(* | SetReadFrameSize )(void *context, unsigned line, unsigned frameSize)
PluginLID_Errors(* | SetWriteFrameSize )(void *context, unsigned line, unsigned frameSize)
PluginLID_Errors(* | GetReadFrameSize )(void *context, unsigned line, unsigned *frameSize)
PluginLID_Errors(* | GetWriteFrameSize )(void *context, unsigned line, unsigned *frameSize)
PluginLID_Errors(* | ReadFrame )(void *context, unsigned line, void *buffer, unsigned *count)
PluginLID_Errors(* | WriteFrame )(void *context, unsigned line, const void *buffer, unsigned count, unsigned *written)
PluginLID_Errors(* | GetAverageSignalLevel )(void *context, unsigned line, PluginLID_Boolean playback, unsigned *signal)
PluginLID_Errors(* | EnableAudio )(void *context, unsigned line, PluginLID_Boolean enable)
PluginLID_Errors(* | IsAudioEnabled )(void *context, unsigned line, PluginLID_Boolean *enable)
PluginLID_Errors(* | SetRecordVolume )(void *context, unsigned line, unsigned volume)
PluginLID_Errors(* | SetPlayVolume )(void *context, unsigned line, unsigned volume)
PluginLID_Errors(* | GetRecordVolume )(void *context, unsigned line, unsigned *volume)
PluginLID_Errors(* | GetPlayVolume )(void *context, unsigned line, unsigned *volume)
PluginLID_Errors(* | GetAEC )(void *context, unsigned line, unsigned *level)
PluginLID_Errors(* | SetAEC )(void *context, unsigned line, unsigned level)
PluginLID_Errors(* | GetVAD )(void *context, unsigned line, PluginLID_Boolean *enable)
PluginLID_Errors(* | SetVAD )(void *context, unsigned line, PluginLID_Boolean enable)
PluginLID_Errors(* | GetCallerID )(void *context, unsigned line, char *idString, unsigned size, PluginLID_Boolean full)
PluginLID_Errors(* | SetCallerID )(void *context, unsigned line, const char *idString)
PluginLID_Errors(* | SendVisualMessageWaitingIndicator )(void *context, unsigned line, PluginLID_Boolean on)
PluginLID_Errors(* | PlayDTMF )(void *context, unsigned line, const char *digits, unsigned onTime, unsigned offTime)
PluginLID_Errors(* | ReadDTMF )(void *context, unsigned line, char *digit)
PluginLID_Errors(* | GetRemoveDTMF )(void *context, unsigned line, PluginLID_Boolean *removeTones)
PluginLID_Errors(* | SetRemoveDTMF )(void *context, unsigned line, PluginLID_Boolean removeTones)
PluginLID_Errors(* | IsToneDetected )(void *context, unsigned line, int *tone)
PluginLID_Errors(* | WaitForToneDetect )(void *context, unsigned line, unsigned timeout, int *tone)
PluginLID_Errors(* | WaitForTone )(void *context, unsigned line, int tone, unsigned timeout)
PluginLID_Errors(* | SetToneParameters )(void *context, unsigned line, unsigned tone, unsigned lowFrequency, unsigned highFrequency, unsigned mixingMode, unsigned numCadences, const unsigned *onTimes, const unsigned *offTimes)
PluginLID_Errors(* | PlayTone )(void *context, unsigned line, unsigned tone)
PluginLID_Errors(* | IsTonePlaying )(void *context, unsigned line, PluginLID_Boolean *playing)
PluginLID_Errors(* | StopTone )(void *context, unsigned line)
PluginLID_Errors(* | DialOut )(void *context, unsigned line, const char *number, struct PluginLID_DialParams *params)
PluginLID_Errors(* | GetWinkDuration )(void *context, unsigned line, unsigned *winkDuration)
PluginLID_Errors(* | SetWinkDuration )(void *context, unsigned line, unsigned winkDuration)
PluginLID_Errors(* | SetCountryCode )(void *context, unsigned country)
PluginLID_Errors(* | GetSupportedCountry )(void *context, unsigned index, unsigned *countryCode)
PluginLID_Errors(* | SetLineConnected )(void *context, unsigned line)
PluginLID_Errors(* | IsLineConnected )(void *context, unsigned line, PluginLID_Boolean *connected)

## Field Documentation

unsigned int PluginLID_Definition::apiVersion

const char* PluginLID_Definition::author

const char* PluginLID_Definition::authorEmail

const char* PluginLID_Definition::authorURL

PluginLID_Errors(* PluginLID_Definition::Close)(void *context)

const char* PluginLID_Definition::copyright

void*(* PluginLID_Definition::Create)(const struct PluginLID_Definition *definition)

const char* PluginLID_Definition::description

void(* PluginLID_Definition::Destroy)(const struct PluginLID_Definition *definition, void *context)

PluginLID_Errors(* PluginLID_Definition::DialOut)(void *context, unsigned line, const char *number, struct PluginLID_DialParams *params)

PluginLID_Errors(* PluginLID_Definition::EnableAudio)(void *context, unsigned line, PluginLID_Boolean enable)

PluginLID_Errors(* PluginLID_Definition::GetAEC)(void *context, unsigned line, unsigned *level)

PluginLID_Errors(* PluginLID_Definition::GetAverageSignalLevel)(void *context, unsigned line, PluginLID_Boolean playback, unsigned *signal)

PluginLID_Errors(* PluginLID_Definition::GetCallerID)(void *context, unsigned line, char *idString, unsigned size, PluginLID_Boolean full)

PluginLID_Errors(* PluginLID_Definition::GetDeviceName)(void *context, unsigned index, char *name, unsigned size)

PluginLID_Errors(* PluginLID_Definition::GetLineCount)(void *context, unsigned *count)

PluginLID_Errors(* PluginLID_Definition::GetPlayVolume)(void *context, unsigned line, unsigned *volume)

PluginLID_Errors(* PluginLID_Definition::GetReadFormat)(void *context, unsigned line, char *mediaFormat, unsigned size)

PluginLID_Errors(* PluginLID_Definition::GetReadFrameSize)(void *context, unsigned line, unsigned *frameSize)

PluginLID_Errors(* PluginLID_Definition::GetRecordVolume)(void *context, unsigned line, unsigned *volume)

PluginLID_Errors(* PluginLID_Definition::GetRemoveDTMF)(void *context, unsigned line, PluginLID_Boolean *removeTones)

PluginLID_Errors(* PluginLID_Definition::GetSupportedCountry)(void *context, unsigned index, unsigned *countryCode)

PluginLID_Errors(* PluginLID_Definition::GetSupportedFormat)(void *context, unsigned index, char *mediaFormat, unsigned size)

PluginLID_Errors(* PluginLID_Definition::GetVAD)(void *context, unsigned line, PluginLID_Boolean *enable)

PluginLID_Errors(* PluginLID_Definition::GetWinkDuration)(void *context, unsigned line, unsigned *winkDuration)

PluginLID_Errors(* PluginLID_Definition::GetWriteFormat)(void *context, unsigned line, char *mediaFormat, unsigned size)

PluginLID_Errors(* PluginLID_Definition::GetWriteFrameSize)(void *context, unsigned line, unsigned *frameSize)

PluginLID_Errors(* PluginLID_Definition::HasHookFlash)(void *context, unsigned line, PluginLID_Boolean *flashed)

PluginLID_Errors(* PluginLID_Definition::HookFlash)(void *context, unsigned line, unsigned flashTime)

PluginLID_Errors(* PluginLID_Definition::IsAudioEnabled)(void *context, unsigned line, PluginLID_Boolean *enable)

PluginLID_Errors(* PluginLID_Definition::IsLineConnected)(void *context, unsigned line, PluginLID_Boolean *connected)

PluginLID_Errors(* PluginLID_Definition::IsLineDisconnected)(void *context, unsigned line, PluginLID_Boolean checkForWink, PluginLID_Boolean *disconnected)

PluginLID_Errors(* PluginLID_Definition::IsLineOffHook)(void *context, unsigned line, PluginLID_Boolean *offHook)

PluginLID_Errors(* PluginLID_Definition::IsLinePresent)(void *context, unsigned line, PluginLID_Boolean forceTest, PluginLID_Boolean *present)

PluginLID_Errors(* PluginLID_Definition::IsLineRinging)(void *context, unsigned line, unsigned long *cadence)

PluginLID_Errors(* PluginLID_Definition::IsLineTerminal)(void *context, unsigned line, PluginLID_Boolean *isTerminal)

PluginLID_Errors(* PluginLID_Definition::IsLineToLineDirect)(void *context, unsigned line1, unsigned line2, PluginLID_Boolean *connected)

PluginLID_Errors(* PluginLID_Definition::IsToneDetected)(void *context, unsigned line, int *tone)

PluginLID_Errors(* PluginLID_Definition::IsTonePlaying)(void *context, unsigned line, PluginLID_Boolean *playing)

const char* PluginLID_Definition::license

const char* PluginLID_Definition::manufacturer

const char* PluginLID_Definition::manufacturerEmail

const char* PluginLID_Definition::manufacturerURL

const char* PluginLID_Definition::model

const char* PluginLID_Definition::name

PluginLID_Errors(* PluginLID_Definition::Open)(void *context, const char *device)

PluginLID_Errors(* PluginLID_Definition::PlayDTMF)(void *context, unsigned line, const char *digits, unsigned onTime, unsigned offTime)

PluginLID_Errors(* PluginLID_Definition::PlayTone)(void *context, unsigned line, unsigned tone)

PluginLID_Errors(* PluginLID_Definition::ReadDTMF)(void *context, unsigned line, char *digit)

PluginLID_Errors(* PluginLID_Definition::ReadFrame)(void *context, unsigned line, void *buffer, unsigned *count)

const char* PluginLID_Definition::revision

PluginLID_Errors(* PluginLID_Definition::RingLine)(void *context, unsigned line, unsigned nCadence, const unsigned *pattern, unsigned frequency)

PluginLID_Errors(* PluginLID_Definition::SendVisualMessageWaitingIndicator)(void *context, unsigned line, PluginLID_Boolean on)

PluginLID_Errors(* PluginLID_Definition::SetAEC)(void *context, unsigned line, unsigned level)

PluginLID_Errors(* PluginLID_Definition::SetCallerID)(void *context, unsigned line, const char *idString)

PluginLID_Errors(* PluginLID_Definition::SetCountryCode)(void *context, unsigned country)

PluginLID_Errors(* PluginLID_Definition::SetLineConnected)(void *context, unsigned line)

PluginLID_Errors(* PluginLID_Definition::SetLineOffHook)(void *context, unsigned line, PluginLID_Boolean newState)

PluginLID_Errors(* PluginLID_Definition::SetLineToLineDirect)(void *context, unsigned line1, unsigned line2, PluginLID_Boolean connect)

PluginLID_Errors(* PluginLID_Definition::SetPlayVolume)(void *context, unsigned line, unsigned volume)

PluginLID_Errors(* PluginLID_Definition::SetReadFormat)(void *context, unsigned line, const char *mediaFormat)

PluginLID_Errors(* PluginLID_Definition::SetReadFrameSize)(void *context, unsigned line, unsigned frameSize)

PluginLID_Errors(* PluginLID_Definition::SetRecordVolume)(void *context, unsigned line, unsigned volume)

PluginLID_Errors(* PluginLID_Definition::SetRemoveDTMF)(void *context, unsigned line, PluginLID_Boolean removeTones)

PluginLID_Errors(* PluginLID_Definition::SetToneParameters)(void *context, unsigned line, unsigned tone, unsigned lowFrequency, unsigned highFrequency, unsigned mixingMode, unsigned numCadences, const unsigned *onTimes, const unsigned *offTimes)

PluginLID_Errors(* PluginLID_Definition::SetVAD)(void *context, unsigned line, PluginLID_Boolean enable)

PluginLID_Errors(* PluginLID_Definition::SetWinkDuration)(void *context, unsigned line, unsigned winkDuration)

PluginLID_Errors(* PluginLID_Definition::SetWriteFormat)(void *context, unsigned line, const char *mediaFormat)

PluginLID_Errors(* PluginLID_Definition::SetWriteFrameSize)(void *context, unsigned line, unsigned frameSize)

PluginLID_Errors(* PluginLID_Definition::StopReading)(void *context, unsigned line)

PluginLID_Errors(* PluginLID_Definition::StopTone)(void *context, unsigned line)

PluginLID_Errors(* PluginLID_Definition::StopWriting)(void *context, unsigned line)

time_t PluginLID_Definition::timestamp

const void* PluginLID_Definition::userData

const char* PluginLID_Definition::version

PluginLID_Errors(* PluginLID_Definition::WaitForTone)(void *context, unsigned line, int tone, unsigned timeout)

PluginLID_Errors(* PluginLID_Definition::WaitForToneDetect)(void *context, unsigned line, unsigned timeout, int *tone)

PluginLID_Errors(* PluginLID_Definition::WriteFrame)(void *context, unsigned line, const void *buffer, unsigned count, unsigned *written)

The documentation for this struct was generated from the following file:

- lidplugin.h