OPAL  Version 3.10.10
PluginLID_GetDefinitionsFunction 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

◆ apiVersion

unsigned int PluginLID_GetDefinitionsFunction::apiVersion

◆ author

const char* PluginLID_GetDefinitionsFunction::author

◆ authorEmail

const char* PluginLID_GetDefinitionsFunction::authorEmail

◆ authorURL

const char* PluginLID_GetDefinitionsFunction::authorURL

◆ Close

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

◆ copyright

const char* PluginLID_GetDefinitionsFunction::copyright

◆ Create

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

◆ description

const char* PluginLID_GetDefinitionsFunction::description

◆ Destroy

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

◆ DialOut

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

◆ EnableAudio

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

◆ GetAEC

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

◆ GetAverageSignalLevel

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

◆ GetCallerID

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

◆ GetDeviceName

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

◆ GetLineCount

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

◆ GetPlayVolume

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

◆ GetReadFormat

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

◆ GetReadFrameSize

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

◆ GetRecordVolume

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

◆ GetRemoveDTMF

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

◆ GetSupportedCountry

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

◆ GetSupportedFormat

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

◆ GetVAD

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

◆ GetWinkDuration

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

◆ GetWriteFormat

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

◆ GetWriteFrameSize

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

◆ HasHookFlash

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

◆ HookFlash

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

◆ IsAudioEnabled

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

◆ IsLineConnected

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

◆ IsLineDisconnected

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

◆ IsLineOffHook

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

◆ IsLinePresent

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

◆ IsLineRinging

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

◆ IsLineTerminal

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

◆ IsLineToLineDirect

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

◆ IsToneDetected

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

◆ IsTonePlaying

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

◆ license

const char* PluginLID_GetDefinitionsFunction::license

◆ manufacturer

const char* PluginLID_GetDefinitionsFunction::manufacturer

◆ manufacturerEmail

const char* PluginLID_GetDefinitionsFunction::manufacturerEmail

◆ manufacturerURL

const char* PluginLID_GetDefinitionsFunction::manufacturerURL

◆ model

const char* PluginLID_GetDefinitionsFunction::model

◆ name

const char* PluginLID_GetDefinitionsFunction::name

◆ Open

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

◆ PlayDTMF

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

◆ PlayTone

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

◆ ReadDTMF

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

◆ ReadFrame

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

◆ revision

const char* PluginLID_GetDefinitionsFunction::revision

◆ RingLine

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

◆ SendVisualMessageWaitingIndicator

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

◆ SetAEC

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

◆ SetCallerID

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

◆ SetCountryCode

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

◆ SetLineConnected

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

◆ SetLineOffHook

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

◆ SetLineToLineDirect

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

◆ SetPlayVolume

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

◆ SetReadFormat

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

◆ SetReadFrameSize

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

◆ SetRecordVolume

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

◆ SetRemoveDTMF

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

◆ SetToneParameters

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

◆ SetVAD

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

◆ SetWinkDuration

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

◆ SetWriteFormat

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

◆ SetWriteFrameSize

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

◆ StopReading

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

◆ StopTone

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

◆ StopWriting

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

◆ timestamp

time_t PluginLID_GetDefinitionsFunction::timestamp

◆ userData

const void* PluginLID_GetDefinitionsFunction::userData

◆ version

const char* PluginLID_GetDefinitionsFunction::version

◆ WaitForTone

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

◆ WaitForToneDetect

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

◆ WriteFrame

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

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