Ir

Allows reception of Ir commands. Typical example (no error checking):. More...

Data Structures

struct  Ir_Attrs
 Attributes used to create an Ir object. More...

Typedefs

typedef struct Ir_Object * Ir_Handle
 Handle through which to reference an Ir Object.

Enumerations

enum  Ir_Key {
  Ir_Key_POWER = 0x300c,
  Ir_Key_CHANINC = 0x3020,
  Ir_Key_CHANDEC = 0x3021,
  Ir_Key_VOLINC = 0x3010,
  Ir_Key_VOLDEC = 0x3011,
  Ir_Key_UP = 0x301c,
  Ir_Key_DOWN = 0x301d,
  Ir_Key_LEFT = 0x302c,
  Ir_Key_RIGHT = 0x302b,
  Ir_Key_OK = 0x302e,
  Ir_Key_MUTE = 0x300d,
  Ir_Key_MENUDONE = 0x300f,
  Ir_Key_INFOSELECT = 0x300f,
  Ir_Key_SLEEP = 0x3026,
  Ir_Key_SUBTITLE = 0x30cb,
  Ir_Key_REPEAT = 0x3022,
  Ir_Key_1 = 0x3001,
  Ir_Key_2 = 0x3002,
  Ir_Key_3 = 0x3003,
  Ir_Key_4 = 0x3004,
  Ir_Key_5 = 0x3005,
  Ir_Key_6 = 0x3006,
  Ir_Key_7 = 0x3007,
  Ir_Key_8 = 0x3008,
  Ir_Key_9 = 0x3009,
  Ir_Key_0 = 0x3000,
  Ir_Key_ENTER = 0x2039,
  Ir_Key_INPUT = 0x20ff,
  Ir_Key_REWIND = 0x3172,
  Ir_Key_PLAY = 0x3175,
  Ir_Key_FASTFORWARD = 0x3174,
  Ir_Key_RECORD = 0x3177,
  Ir_Key_STOP = 0x3176,
  Ir_Key_PAUSE = 0x3169
}
 The different keys supported on the Ir remote. More...

Functions

Ir_Handle Ir_create (Ir_Attrs *attrs)
 Creates an Ir object.
Int Ir_getKey (Ir_Handle hIr, Ir_Key *key)
 Get a key from the Ir.
Int Ir_delete (Ir_Handle hIr)
 Deletes an Ir Object.

Variables

const Ir_Attrs Ir_Attrs_DEFAULT
 Default attributes for an Ir object.

Detailed Description

Allows reception of Ir commands. Typical example (no error checking):.

   #include <xdc/std.h>
   #include <ti/sdo/dmai/Dmai.h>
   #include <ti/sdo/dmai/Ir.h>
   Ir_Handle hIr;
   Ir_Attrs irAttrs = Ir_Attrs_DEFAULT;
   Ir_Key key;
 
   Dmai_init();
   hIr = Ir_create(&irAttrs);
   Ir_getKey(hIr, &key);
   // The received key is now available in the key variable.

Typedef Documentation

typedef struct Ir_Object* Ir_Handle

Handle through which to reference an Ir Object.


Enumeration Type Documentation

enum Ir_Key

The different keys supported on the Ir remote.

Enumerator:
Ir_Key_POWER 
Ir_Key_CHANINC 
Ir_Key_CHANDEC 
Ir_Key_VOLINC 
Ir_Key_VOLDEC 
Ir_Key_UP 
Ir_Key_DOWN 
Ir_Key_LEFT 
Ir_Key_RIGHT 
Ir_Key_OK 
Ir_Key_MUTE 
Ir_Key_MENUDONE 
Ir_Key_INFOSELECT 
Ir_Key_SLEEP 
Ir_Key_SUBTITLE 
Ir_Key_REPEAT 
Ir_Key_1 
Ir_Key_2 
Ir_Key_3 
Ir_Key_4 
Ir_Key_5 
Ir_Key_6 
Ir_Key_7 
Ir_Key_8 
Ir_Key_9 
Ir_Key_0 
Ir_Key_ENTER 
Ir_Key_INPUT 
Ir_Key_REWIND 
Ir_Key_PLAY 
Ir_Key_FASTFORWARD 
Ir_Key_RECORD 
Ir_Key_STOP 
Ir_Key_PAUSE 


Function Documentation

Ir_Handle Ir_create ( Ir_Attrs attrs  ) 

Creates an Ir object.

Return values:
Handle for use in subsequent operations (see Ir_Handle).
NULL for failure.

Int Ir_getKey ( Ir_Handle  hIr,
Ir_Key key 
)

Get a key from the Ir.

Parameters:
[in] hIr The Ir_Handle from which to receive a keycode.
[out] key Pointer to a received Ir_Key.
Return values:
Dmai_EOK for success.
Negative value for failure, see Dmai.h.
Remarks:
Ir_create must be called before this function.

Int Ir_delete ( Ir_Handle  hIr  ) 

Deletes an Ir Object.

Parameters:
[in] hIr The Ir_Handle to delete.
Return values:
Dmai_EOK for success.
Negative value for failure, see Dmai.h.
Remarks:
Ir_create must be called before this function.


Variable Documentation

Default attributes for an Ir object.


Copyright 2011, Texas Instruments Incorporated