Some Doxygen in upnp_tv_device.
This commit is contained in:
parent
0d625bd2e1
commit
d5fa48bd37
@ -1481,7 +1481,7 @@ TvDeviceSetContrast( IN IXML_Document *in, OUT IXML_Document **out, OUT char **e
|
|||||||
* IXML_Document **out - action result document
|
* IXML_Document **out - action result document
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
* char **errorString - errorString (in case action was unsuccessful)
|
||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
int
|
static int
|
||||||
IncrementContrast( IN int incr, IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
IncrementContrast( IN int incr, IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
||||||
{
|
{
|
||||||
int curcontrast;
|
int curcontrast;
|
||||||
@ -1532,59 +1532,20 @@ IncrementContrast( IN int incr, IN IXML_Document *in, OUT IXML_Document **out, O
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceIncreaseContrast(IXML_Document *in, IXML_Document **out,
|
||||||
* TvDeviceIncreaseContrast
|
char **errorString)
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
*
|
|
||||||
* Increase the contrast.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
* IXML_Document * in - action request document
|
|
||||||
* IXML_Document **out - action result document
|
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceIncreaseContrast( IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
|
||||||
{
|
{
|
||||||
return IncrementContrast( 1, in, out, errorString );
|
return IncrementContrast(1, in, out, errorString);
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceDecreaseContrast(IXML_Document *in, IXML_Document **out,
|
||||||
* TvDeviceDecreaseContrast
|
char **errorString)
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Decrease the contrast.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
* IXML_Document * in - action request document
|
|
||||||
* IXML_Document **out - action result document
|
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceDecreaseContrast( IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
|
||||||
{
|
{
|
||||||
return IncrementContrast( -1, in, out, errorString );
|
return IncrementContrast(-1, in, out, errorString);
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceSetBrightness(IXML_Document *in, IXML_Document **out,
|
||||||
* TvDeviceSetBrightness
|
char **errorString)
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Change the brightness, update the TvDevice picture service
|
|
||||||
* state table, and notify all subscribed control points of the
|
|
||||||
* updated state.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
* brightness -- The brightness value to change to.
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceSetBrightness( IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
|
||||||
{
|
{
|
||||||
char *value = NULL;
|
char *value = NULL;
|
||||||
int brightness = -1;
|
int brightness = -1;
|
||||||
@ -1630,22 +1591,19 @@ TvDeviceSetBrightness( IN IXML_Document *in, OUT IXML_Document **out, OUT char *
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
/*!
|
||||||
* IncrementBrightness
|
* \brief Increment the brightness. Read the current brightness from the state
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Increment the brightness. Read the current brightness from the state
|
|
||||||
* table, add the increment, and then change the brightness.
|
* table, add the increment, and then change the brightness.
|
||||||
*
|
*/
|
||||||
* Parameters:
|
static int IncrementBrightness(
|
||||||
* incr -- The increment by which to change the brightness.
|
/*! [in] The increment by which to change the brightness. */
|
||||||
*
|
IN int incr,
|
||||||
* IXML_Document * in - action request document
|
/*! [in] action request document. */
|
||||||
* IXML_Document **out - action result document
|
IN IXML_Document *in,
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
/*! [out] action result document. */
|
||||||
*****************************************************************************/
|
OUT IXML_Document **out,
|
||||||
int
|
/*! [out] errorString (in case action was unsuccessful). */
|
||||||
IncrementBrightness( IN int incr, IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
OUT char **errorString)
|
||||||
{
|
{
|
||||||
int curbrightness;
|
int curbrightness;
|
||||||
int newbrightness;
|
int newbrightness;
|
||||||
@ -1695,62 +1653,16 @@ IncrementBrightness( IN int incr, IN IXML_Document *in, OUT IXML_Document **out,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceIncreaseBrightness(IXML_Document *in, IXML_Document **out, char **errorString)
|
||||||
* TvDeviceIncreaseBrightness
|
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Increase brightness.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
* IXML_Document * in - action request document
|
|
||||||
* IXML_Document **out - action result document
|
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceIncreaseBrightness( IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
|
||||||
{
|
{
|
||||||
return IncrementBrightness( 1, in, out, errorString );
|
return IncrementBrightness(1, in, out, errorString);
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceDecreaseBrightness(IXML_Document *in, IXML_Document **out, char **errorString)
|
||||||
* TvDeviceDecreaseBrightness
|
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Decrease brightnesss.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
* IXML_Document * in - action request document
|
|
||||||
* IXML_Document **out - action result document
|
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceDecreaseBrightness( IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
|
||||||
{
|
{
|
||||||
return IncrementBrightness( -1, in, out, errorString );
|
return IncrementBrightness(-1, in, out, errorString);
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TvDeviceCallbackEventHandler
|
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* The callback handler registered with the SDK while registering
|
|
||||||
* root device. Dispatches the request to the appropriate procedure
|
|
||||||
* based on the value of EventType. The four requests handled by the
|
|
||||||
* device are:
|
|
||||||
* 1) Event Subscription requests.
|
|
||||||
* 2) Get Variable requests.
|
|
||||||
* 3) Action requests.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
* EventType -- The type of callback event
|
|
||||||
* Event -- Data structure containing event data
|
|
||||||
* Cookie -- Optional data specified during callback registration
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int TvDeviceCallbackEventHandler(Upnp_EventType EventType, void *Event, void *Cookie)
|
int TvDeviceCallbackEventHandler(Upnp_EventType EventType, void *Event, void *Cookie)
|
||||||
{
|
{
|
||||||
switch (EventType) {
|
switch (EventType) {
|
||||||
@ -1792,15 +1704,6 @@ int TvDeviceCallbackEventHandler(Upnp_EventType EventType, void *Event, void *Co
|
|||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TvDeviceStop
|
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Stops the device. Uninitializes the sdk.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int TvDeviceStop(void)
|
int TvDeviceStop(void)
|
||||||
{
|
{
|
||||||
UpnpUnRegisterRootDevice( device_handle );
|
UpnpUnRegisterRootDevice( device_handle );
|
||||||
@ -1811,33 +1714,8 @@ int TvDeviceStop(void)
|
|||||||
return UPNP_E_SUCCESS;
|
return UPNP_E_SUCCESS;
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceStart(char *ip_address, unsigned short port, char *desc_doc_name,
|
||||||
* TvDeviceStart
|
char *web_dir_path, print_string pfun)
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Initializes the UPnP Sdk, registers the device, and sends out
|
|
||||||
* advertisements.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
* ip_address - ip address to initialize the sdk (may be NULL)
|
|
||||||
* if null, then the first non null loopback address is used.
|
|
||||||
* port - port number to initialize the sdk (may be 0)
|
|
||||||
* if zero, then a random number is used.
|
|
||||||
* desc_doc_name - name of description document.
|
|
||||||
* may be NULL. Default is tvcombodesc.xml
|
|
||||||
* web_dir_path - path of web directory.
|
|
||||||
* may be NULL. Default is ./web (for Linux) or ../tvdevice/web
|
|
||||||
* for windows.
|
|
||||||
* pfun - print function to use.
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceStart( char *ip_address,
|
|
||||||
unsigned short port,
|
|
||||||
char *desc_doc_name,
|
|
||||||
char *web_dir_path,
|
|
||||||
print_string pfun )
|
|
||||||
{
|
{
|
||||||
int ret = UPNP_E_SUCCESS;
|
int ret = UPNP_E_SUCCESS;
|
||||||
char desc_doc_url[DESC_URL_SIZE];
|
char desc_doc_url[DESC_URL_SIZE];
|
||||||
|
@ -269,26 +269,24 @@ int TvDeviceHandleGetVarRequest(UpnpStateVarRequest *);
|
|||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
int TvDeviceHandleActionRequest(UpnpActionRequest *);
|
int TvDeviceHandleActionRequest(UpnpActionRequest *);
|
||||||
|
|
||||||
/******************************************************************************
|
/*!
|
||||||
* TvDeviceCallbackEventHandler
|
* \brief The callback handler registered with the SDK while registering
|
||||||
|
* root device.
|
||||||
*
|
*
|
||||||
* Description:
|
* Dispatches the request to the appropriate procedure
|
||||||
* The callback handler registered with the SDK while registering
|
|
||||||
* root device. Dispatches the request to the appropriate procedure
|
|
||||||
* based on the value of EventType. The four requests handled by the
|
* based on the value of EventType. The four requests handled by the
|
||||||
* device are:
|
* device are:
|
||||||
* 1) Event Subscription requests.
|
* \li 1) Event Subscription requests.
|
||||||
* 2) Get Variable requests.
|
* \li 2) Get Variable requests.
|
||||||
* 3) Action requests.
|
* \li 3) Action requests.
|
||||||
*
|
*/
|
||||||
* Parameters:
|
int TvDeviceCallbackEventHandler(
|
||||||
*
|
/*! [in] The type of callback event. */
|
||||||
* EventType -- The type of callback event
|
Upnp_EventType,
|
||||||
* Event -- Data structure containing event data
|
/*! [in] Data structure containing event data. */
|
||||||
* Cookie -- Optional data specified during callback registration
|
void *Event,
|
||||||
*
|
/*! [in] Optional data specified during callback registration. */
|
||||||
*****************************************************************************/
|
void *Cookie);
|
||||||
int TvDeviceCallbackEventHandler(Upnp_EventType, void*, void*);
|
|
||||||
|
|
||||||
/******************************************************************************
|
/******************************************************************************
|
||||||
* TvDeviceSetServiceTableVar
|
* TvDeviceSetServiceTableVar
|
||||||
@ -578,51 +576,64 @@ int TvDeviceIncreaseContrast(IN IXML_Document *in, OUT IXML_Document **out, OUT
|
|||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
int TvDeviceDecreaseContrast(IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString);
|
int TvDeviceDecreaseContrast(IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString);
|
||||||
|
|
||||||
/******************************************************************************
|
/*!
|
||||||
* TvDeviceSetBrightness
|
* \brief Change the brightness, update the TvDevice picture service
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Change the brightness, update the TvDevice picture service
|
|
||||||
* state table, and notify all subscribed control points of the
|
* state table, and notify all subscribed control points of the
|
||||||
* updated state.
|
* updated state.
|
||||||
*
|
*/
|
||||||
* Parameters:
|
int TvDeviceSetBrightness(
|
||||||
* brightness -- The brightness value to change to.
|
/*! [in] Document with the brightness value to change to. */
|
||||||
*
|
IN IXML_Document *in,
|
||||||
*****************************************************************************/
|
/*! [out] action result document. */
|
||||||
int TvDeviceSetBrightness(IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString);
|
OUT IXML_Document **out,
|
||||||
|
/*! [out] errorString (in case action was unsuccessful). */
|
||||||
|
OUT char **errorString);
|
||||||
|
|
||||||
/******************************************************************************
|
/*!
|
||||||
* TvDeviceIncreaseBrightness
|
* \brief Increase brightnesss.
|
||||||
*
|
*/
|
||||||
* Description:
|
int TvDeviceIncreaseBrightness(
|
||||||
* Increase brightness.
|
/*! [in] action request document. */
|
||||||
*
|
IN IXML_Document *in,
|
||||||
* Parameters:
|
/*! [out] action result document. */
|
||||||
*
|
OUT IXML_Document **out,
|
||||||
* IXML_Document * in - action request document
|
/*! [out] errorString (in case action was unsuccessful). */
|
||||||
* IXML_Document **out - action result document
|
OUT char **errorString);
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int TvDeviceIncreaseBrightness(IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString);
|
|
||||||
|
|
||||||
/******************************************************************************
|
/*!
|
||||||
* TvDeviceDecreaseBrightness
|
* \brief Decrease brightnesss.
|
||||||
*
|
*/
|
||||||
* Description:
|
int TvDeviceDecreaseBrightness(
|
||||||
* Decrease brightnesss.
|
/*! [in] action request document. */
|
||||||
*
|
IN IXML_Document *in,
|
||||||
* Parameters:
|
/*! [out] action result document. */
|
||||||
* IXML_Document * in - action request document
|
OUT IXML_Document **out,
|
||||||
* IXML_Document **out - action result document
|
/*! [out] errorString (in case action was unsuccessful). */
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
OUT char **errorString);
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int TvDeviceDecreaseBrightness(IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString);
|
|
||||||
|
|
||||||
int TvDeviceStart(char * ip_address, unsigned short port,char * desc_doc_name,
|
/*!
|
||||||
char *web_dir_path, print_string pfun);
|
* \brief Initializes the UPnP Sdk, registers the device, and sends out
|
||||||
|
* advertisements.
|
||||||
|
*/
|
||||||
|
int TvDeviceStart(
|
||||||
|
/*! [in] ip address to initialize the sdk (may be NULL)
|
||||||
|
* if null, then the first non null loopback address is used. */
|
||||||
|
char *ip_address,
|
||||||
|
/*! [in] port number to initialize the sdk (may be 0)
|
||||||
|
* if zero, then a random number is used. */
|
||||||
|
unsigned short port,
|
||||||
|
/*! [in] name of description document.
|
||||||
|
* may be NULL. Default is tvdevicedesc.xml. */
|
||||||
|
char *desc_doc_name,
|
||||||
|
/*! [in] path of web directory.
|
||||||
|
* may be NULL. Default is ./web (for Linux) or ../tvdevice/web. */
|
||||||
|
char *web_dir_path,
|
||||||
|
/*! [in] print function to use. */
|
||||||
|
print_string pfun);
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* \brief Stops the device. Uninitializes the sdk.
|
||||||
|
*/
|
||||||
int TvDeviceStop(void);
|
int TvDeviceStop(void);
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
@ -630,3 +641,4 @@ int TvDeviceStop(void);
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
@ -1483,7 +1483,7 @@ TvDeviceSetContrast( IN IXML_Document *in, OUT IXML_Document **out, OUT char **e
|
|||||||
* IXML_Document **out - action result document
|
* IXML_Document **out - action result document
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
* char **errorString - errorString (in case action was unsuccessful)
|
||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
int
|
static int
|
||||||
IncrementContrast( IN int incr, IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
IncrementContrast( IN int incr, IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
||||||
{
|
{
|
||||||
int curcontrast;
|
int curcontrast;
|
||||||
@ -1534,59 +1534,20 @@ IncrementContrast( IN int incr, IN IXML_Document *in, OUT IXML_Document **out, O
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceIncreaseContrast(IXML_Document *in, IXML_Document **out,
|
||||||
* TvDeviceIncreaseContrast
|
char **errorString)
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
*
|
|
||||||
* Increase the contrast.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
* IXML_Document * in - action request document
|
|
||||||
* IXML_Document **out - action result document
|
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceIncreaseContrast( IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
|
||||||
{
|
{
|
||||||
return IncrementContrast( 1, in, out, errorString );
|
return IncrementContrast(1, in, out, errorString);
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceDecreaseContrast(IXML_Document *in, IXML_Document **out,
|
||||||
* TvDeviceDecreaseContrast
|
char **errorString)
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Decrease the contrast.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
* IXML_Document * in - action request document
|
|
||||||
* IXML_Document **out - action result document
|
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceDecreaseContrast( IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
|
||||||
{
|
{
|
||||||
return IncrementContrast( -1, in, out, errorString );
|
return IncrementContrast(-1, in, out, errorString);
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceSetBrightness(IXML_Document *in, IXML_Document **out,
|
||||||
* TvDeviceSetBrightness
|
char **errorString)
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Change the brightness, update the TvDevice picture service
|
|
||||||
* state table, and notify all subscribed control points of the
|
|
||||||
* updated state.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
* brightness -- The brightness value to change to.
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceSetBrightness( IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
|
||||||
{
|
{
|
||||||
char *value = NULL;
|
char *value = NULL;
|
||||||
int brightness = -1;
|
int brightness = -1;
|
||||||
@ -1632,22 +1593,19 @@ TvDeviceSetBrightness( IN IXML_Document *in, OUT IXML_Document **out, OUT char *
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
/*!
|
||||||
* IncrementBrightness
|
* \brief Increment the brightness. Read the current brightness from the state
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Increment the brightness. Read the current brightness from the state
|
|
||||||
* table, add the increment, and then change the brightness.
|
* table, add the increment, and then change the brightness.
|
||||||
*
|
*/
|
||||||
* Parameters:
|
static int IncrementBrightness(
|
||||||
* incr -- The increment by which to change the brightness.
|
/*! [in] The increment by which to change the brightness. */
|
||||||
*
|
IN int incr,
|
||||||
* IXML_Document * in - action request document
|
/*! [in] action request document. */
|
||||||
* IXML_Document **out - action result document
|
IN IXML_Document *in,
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
/*! [out] action result document. */
|
||||||
*****************************************************************************/
|
OUT IXML_Document **out,
|
||||||
int
|
/*! [out] errorString (in case action was unsuccessful). */
|
||||||
IncrementBrightness( IN int incr, IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
OUT char **errorString)
|
||||||
{
|
{
|
||||||
int curbrightness;
|
int curbrightness;
|
||||||
int newbrightness;
|
int newbrightness;
|
||||||
@ -1697,62 +1655,16 @@ IncrementBrightness( IN int incr, IN IXML_Document *in, OUT IXML_Document **out,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceIncreaseBrightness(IXML_Document *in, IXML_Document **out, char **errorString)
|
||||||
* TvDeviceIncreaseBrightness
|
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Increase brightness.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
* IXML_Document * in - action request document
|
|
||||||
* IXML_Document **out - action result document
|
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceIncreaseBrightness( IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
|
||||||
{
|
{
|
||||||
return IncrementBrightness( 1, in, out, errorString );
|
return IncrementBrightness(1, in, out, errorString);
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceDecreaseBrightness(IXML_Document *in, IXML_Document **out, char **errorString)
|
||||||
* TvDeviceDecreaseBrightness
|
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Decrease brightnesss.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
* IXML_Document * in - action request document
|
|
||||||
* IXML_Document **out - action result document
|
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceDecreaseBrightness( IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString )
|
|
||||||
{
|
{
|
||||||
return IncrementBrightness( -1, in, out, errorString );
|
return IncrementBrightness(-1, in, out, errorString);
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TvDeviceCallbackEventHandler
|
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* The callback handler registered with the SDK while registering
|
|
||||||
* root device. Dispatches the request to the appropriate procedure
|
|
||||||
* based on the value of EventType. The four requests handled by the
|
|
||||||
* device are:
|
|
||||||
* 1) Event Subscription requests.
|
|
||||||
* 2) Get Variable requests.
|
|
||||||
* 3) Action requests.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
* EventType -- The type of callback event
|
|
||||||
* Event -- Data structure containing event data
|
|
||||||
* Cookie -- Optional data specified during callback registration
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int TvDeviceCallbackEventHandler(Upnp_EventType EventType, void *Event, void *Cookie)
|
int TvDeviceCallbackEventHandler(Upnp_EventType EventType, void *Event, void *Cookie)
|
||||||
{
|
{
|
||||||
switch (EventType) {
|
switch (EventType) {
|
||||||
@ -1794,15 +1706,6 @@ int TvDeviceCallbackEventHandler(Upnp_EventType EventType, void *Event, void *Co
|
|||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TvDeviceStop
|
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Stops the device. Uninitializes the sdk.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int TvDeviceStop(void)
|
int TvDeviceStop(void)
|
||||||
{
|
{
|
||||||
UpnpUnRegisterRootDevice( device_handle );
|
UpnpUnRegisterRootDevice( device_handle );
|
||||||
@ -1813,33 +1716,8 @@ int TvDeviceStop(void)
|
|||||||
return UPNP_E_SUCCESS;
|
return UPNP_E_SUCCESS;
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************************************
|
int TvDeviceStart(char *ip_address, unsigned short port, char *desc_doc_name,
|
||||||
* TvDeviceStart
|
char *web_dir_path, print_string pfun)
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Initializes the UPnP Sdk, registers the device, and sends out
|
|
||||||
* advertisements.
|
|
||||||
*
|
|
||||||
* Parameters:
|
|
||||||
*
|
|
||||||
* ip_address - ip address to initialize the sdk (may be NULL)
|
|
||||||
* if null, then the first non null loopback address is used.
|
|
||||||
* port - port number to initialize the sdk (may be 0)
|
|
||||||
* if zero, then a random number is used.
|
|
||||||
* desc_doc_name - name of description document.
|
|
||||||
* may be NULL. Default is tvdevicedesc.xml
|
|
||||||
* web_dir_path - path of web directory.
|
|
||||||
* may be NULL. Default is ./web (for Linux) or ../tvdevice/web
|
|
||||||
* for windows.
|
|
||||||
* pfun - print function to use.
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int
|
|
||||||
TvDeviceStart( char *ip_address,
|
|
||||||
unsigned short port,
|
|
||||||
char *desc_doc_name,
|
|
||||||
char *web_dir_path,
|
|
||||||
print_string pfun )
|
|
||||||
{
|
{
|
||||||
int ret = UPNP_E_SUCCESS;
|
int ret = UPNP_E_SUCCESS;
|
||||||
char desc_doc_url[DESC_URL_SIZE];
|
char desc_doc_url[DESC_URL_SIZE];
|
||||||
|
@ -269,26 +269,24 @@ int TvDeviceHandleGetVarRequest(UpnpStateVarRequest *);
|
|||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
int TvDeviceHandleActionRequest(UpnpActionRequest *);
|
int TvDeviceHandleActionRequest(UpnpActionRequest *);
|
||||||
|
|
||||||
/******************************************************************************
|
/*!
|
||||||
* TvDeviceCallbackEventHandler
|
* \brief The callback handler registered with the SDK while registering
|
||||||
|
* root device.
|
||||||
*
|
*
|
||||||
* Description:
|
* Dispatches the request to the appropriate procedure
|
||||||
* The callback handler registered with the SDK while registering
|
|
||||||
* root device. Dispatches the request to the appropriate procedure
|
|
||||||
* based on the value of EventType. The four requests handled by the
|
* based on the value of EventType. The four requests handled by the
|
||||||
* device are:
|
* device are:
|
||||||
* 1) Event Subscription requests.
|
* \li 1) Event Subscription requests.
|
||||||
* 2) Get Variable requests.
|
* \li 2) Get Variable requests.
|
||||||
* 3) Action requests.
|
* \li 3) Action requests.
|
||||||
*
|
*/
|
||||||
* Parameters:
|
int TvDeviceCallbackEventHandler(
|
||||||
*
|
/*! [in] The type of callback event. */
|
||||||
* EventType -- The type of callback event
|
Upnp_EventType,
|
||||||
* Event -- Data structure containing event data
|
/*! [in] Data structure containing event data. */
|
||||||
* Cookie -- Optional data specified during callback registration
|
void *Event,
|
||||||
*
|
/*! [in] Optional data specified during callback registration. */
|
||||||
*****************************************************************************/
|
void *Cookie);
|
||||||
int TvDeviceCallbackEventHandler(Upnp_EventType, void*, void*);
|
|
||||||
|
|
||||||
/******************************************************************************
|
/******************************************************************************
|
||||||
* TvDeviceSetServiceTableVar
|
* TvDeviceSetServiceTableVar
|
||||||
@ -578,51 +576,64 @@ int TvDeviceIncreaseContrast(IN IXML_Document *in, OUT IXML_Document **out, OUT
|
|||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
int TvDeviceDecreaseContrast(IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString);
|
int TvDeviceDecreaseContrast(IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString);
|
||||||
|
|
||||||
/******************************************************************************
|
/*!
|
||||||
* TvDeviceSetBrightness
|
* \brief Change the brightness, update the TvDevice picture service
|
||||||
*
|
|
||||||
* Description:
|
|
||||||
* Change the brightness, update the TvDevice picture service
|
|
||||||
* state table, and notify all subscribed control points of the
|
* state table, and notify all subscribed control points of the
|
||||||
* updated state.
|
* updated state.
|
||||||
*
|
*/
|
||||||
* Parameters:
|
int TvDeviceSetBrightness(
|
||||||
* brightness -- The brightness value to change to.
|
/*! [in] Document with the brightness value to change to. */
|
||||||
*
|
IN IXML_Document *in,
|
||||||
*****************************************************************************/
|
/*! [out] action result document. */
|
||||||
int TvDeviceSetBrightness(IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString);
|
OUT IXML_Document **out,
|
||||||
|
/*! [out] errorString (in case action was unsuccessful). */
|
||||||
|
OUT char **errorString);
|
||||||
|
|
||||||
/******************************************************************************
|
/*!
|
||||||
* TvDeviceIncreaseBrightness
|
* \brief Increase brightnesss.
|
||||||
*
|
*/
|
||||||
* Description:
|
int TvDeviceIncreaseBrightness(
|
||||||
* Increase brightness.
|
/*! [in] action request document. */
|
||||||
*
|
IN IXML_Document *in,
|
||||||
* Parameters:
|
/*! [out] action result document. */
|
||||||
*
|
OUT IXML_Document **out,
|
||||||
* IXML_Document * in - action request document
|
/*! [out] errorString (in case action was unsuccessful). */
|
||||||
* IXML_Document **out - action result document
|
OUT char **errorString);
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int TvDeviceIncreaseBrightness(IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString);
|
|
||||||
|
|
||||||
/******************************************************************************
|
/*!
|
||||||
* TvDeviceDecreaseBrightness
|
* \brief Decrease brightnesss.
|
||||||
*
|
*/
|
||||||
* Description:
|
int TvDeviceDecreaseBrightness(
|
||||||
* Decrease brightnesss.
|
/*! [in] action request document. */
|
||||||
*
|
IN IXML_Document *in,
|
||||||
* Parameters:
|
/*! [out] action result document. */
|
||||||
* IXML_Document * in - action request document
|
OUT IXML_Document **out,
|
||||||
* IXML_Document **out - action result document
|
/*! [out] errorString (in case action was unsuccessful). */
|
||||||
* char **errorString - errorString (in case action was unsuccessful)
|
OUT char **errorString);
|
||||||
*
|
|
||||||
*****************************************************************************/
|
|
||||||
int TvDeviceDecreaseBrightness(IN IXML_Document *in, OUT IXML_Document **out, OUT char **errorString);
|
|
||||||
|
|
||||||
int TvDeviceStart(char * ip_address, unsigned short port,char * desc_doc_name,
|
/*!
|
||||||
char *web_dir_path, print_string pfun);
|
* \brief Initializes the UPnP Sdk, registers the device, and sends out
|
||||||
|
* advertisements.
|
||||||
|
*/
|
||||||
|
int TvDeviceStart(
|
||||||
|
/*! [in] ip address to initialize the sdk (may be NULL)
|
||||||
|
* if null, then the first non null loopback address is used. */
|
||||||
|
char *ip_address,
|
||||||
|
/*! [in] port number to initialize the sdk (may be 0)
|
||||||
|
* if zero, then a random number is used. */
|
||||||
|
unsigned short port,
|
||||||
|
/*! [in] name of description document.
|
||||||
|
* may be NULL. Default is tvdevicedesc.xml. */
|
||||||
|
char *desc_doc_name,
|
||||||
|
/*! [in] path of web directory.
|
||||||
|
* may be NULL. Default is ./web (for Linux) or ../tvdevice/web. */
|
||||||
|
char *web_dir_path,
|
||||||
|
/*! [in] print function to use. */
|
||||||
|
print_string pfun);
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* \brief Stops the device. Uninitializes the sdk.
|
||||||
|
*/
|
||||||
int TvDeviceStop(void);
|
int TvDeviceStop(void);
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
@ -630,3 +641,4 @@ int TvDeviceStop(void);
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user