diff --git a/include/dsCompositeIn.h b/include/dsCompositeIn.h index 477711d..c4c55f0 100644 --- a/include/dsCompositeIn.h +++ b/include/dsCompositeIn.h @@ -180,7 +180,9 @@ dsError_t dsCompositeInGetNumberOfInputs (uint8_t *pNumberOfInputs); * * @warning This API is Not thread safe. * - * @pre dsCompositeInInit() should be called before calling this API. + * @pre dsCompositeInInit() should be called before calling this API. + * After every operation, that may change 'dsCompositeInStatus_t',should wait until the + * 'dsCompositeInStatusChangeCB_t' callback is received. */ dsError_t dsCompositeInGetStatus (dsCompositeInStatus_t *pStatus); @@ -202,6 +204,7 @@ dsError_t dsCompositeInGetStatus (dsCompositeInStatus_t *pStatus); * * @note When a port is selected that port should be set as activePort in ::dsCompositeInStatus_t. * Also, if there is a signal (ie isPortConnected[that port ID] is true), once active, isPresented should be set to true as well. + * Any change in the variable - 'dsCompositeInStatus_t' will be communicated via the 'dsCompositeInStatusChangeCB_t' callback. * * @pre dsCompositeInInit() should be called before calling this API. */ diff --git a/include/dsHdmiIn.h b/include/dsHdmiIn.h index 4851d46..229cbdf 100644 --- a/include/dsHdmiIn.h +++ b/include/dsHdmiIn.h @@ -181,7 +181,9 @@ dsError_t dsHdmiInGetNumberOfInputs (uint8_t *pNumberOfinputs); * @retval dsERR_OPERATION_FAILED - The attempted operation has failed * * @pre dsHdmiInInit() must be called before calling this API. - * + * After every operation, that may change 'dsHdmiInStatus_t',should wait until the + * 'dsHdmiInStatusChangeCB_t' callback is received. + * * @warning This API is Not thread safe. * */ @@ -213,8 +215,9 @@ dsError_t dsHdmiInGetStatus (dsHdmiInStatus_t *pStatus); * @pre dsHdmiInInit() must be called before calling this API. * * @note When a port is selected, activePort should be set to true in Please refer ::dsHdmiInStatus_t for that port - * Also, if thT port has an active connection, it should update isPresented to true as well. - * + * Also, if the port has an active connection, it should update isPresented to true as well. + * Any change in the variable - 'dsHdmiInSignalStatus_t' will be communicated via the 'dsHdmiInStatusChangeCB_t' callback. + * * @warning This API is Not thread safe. * */