C# Class UsbUirt.Learner

Inheritance: DriverUserBase
Mostra file Open project: JordanZaerr/Usb-Uirt-managed-wrapper Class Usage Examples

Public Methods

Method Description
Learn ( CodeFormat codeFormat = null, LearnCodeModifier learnCodeFormat = null, uint forcedFrequency = null, System.TimeSpan timeout = null ) : string

Learns an IR code synchronously.
LearnAsync ( CodeFormat codeFormat = null, LearnCodeModifier learnCodeModifier = null, uint forcedFrequency = null, object userState = null ) : Task

Learns an IR code asynchronously.
LearnAsyncCancel ( object userState ) : bool

Cancels a LearnAsync() operation that was passed the specified userState.
LearnAsyncCancel ( ) : void

Cancels a LearnAsync() operation.
Learner ( CodeFormat defaultCodeFormat = CodeFormat.Pronto, LearnCodeModifier defaultLearnCodeModifier = LearnCodeModifier.Default ) : System
Learner ( Driver driver, CodeFormat defaultCodeFormat = CodeFormat.Pronto, LearnCodeModifier defaultLearnCodeModifier = LearnCodeModifier.Default ) : System

Private Methods

Method Description
LearnCallbackProc ( uint progress, uint sigQuality, uint carrierFreq, IntPtr userState ) : void
LearnInternal ( object state ) : string
UUIRTLearnIR ( IntPtr hDrvHandle, int codeFormat, StringBuilder IRCode, LearnCallback progressProc, IntPtr userData, IntPtr pAbort, uint param1, IntPtr reserved0, IntPtr reserved1 ) : bool

Method Details

Learn() public method

Learns an IR code synchronously.
public Learn ( CodeFormat codeFormat = null, LearnCodeModifier learnCodeFormat = null, uint forcedFrequency = null, System.TimeSpan timeout = null ) : string
codeFormat CodeFormat The format of the IR code to use in learning.
learnCodeFormat LearnCodeModifier The modifier used for the code format.
forcedFrequency uint The frequency to use in learning.
timeout System.TimeSpan The timeout after which to abort learning if it has not completed.
return string

LearnAsync() public method

Learns an IR code asynchronously.
public LearnAsync ( CodeFormat codeFormat = null, LearnCodeModifier learnCodeModifier = null, uint forcedFrequency = null, object userState = null ) : Task
codeFormat CodeFormat The format of the IR code to use in learning.
learnCodeModifier LearnCodeModifier The modifier used for the code format.
forcedFrequency uint The frequency to use in learning.
userState object An optional user state object that will be passed to the /// Learning and LearnCompleted events and which can be used when calling LearnAsyncCancel().
return Task

LearnAsyncCancel() public method

Cancels a LearnAsync() operation that was passed the specified userState.
public LearnAsyncCancel ( object userState ) : bool
userState object The optional userState object passed to LearnAsync().
return bool

LearnAsyncCancel() public method

Cancels a LearnAsync() operation.
public LearnAsyncCancel ( ) : void
return void

Learner() public method

public Learner ( CodeFormat defaultCodeFormat = CodeFormat.Pronto, LearnCodeModifier defaultLearnCodeModifier = LearnCodeModifier.Default ) : System
defaultCodeFormat CodeFormat
defaultLearnCodeModifier LearnCodeModifier
return System

Learner() public method

public Learner ( Driver driver, CodeFormat defaultCodeFormat = CodeFormat.Pronto, LearnCodeModifier defaultLearnCodeModifier = LearnCodeModifier.Default ) : System
driver Driver
defaultCodeFormat CodeFormat
defaultLearnCodeModifier LearnCodeModifier
return System