aud_stop_all_tones_req.c

Motorola synergy audio component

/*==================================================================================================
                                                                               
    Module Name:  aud_stop_all_tones_req.c

    General Description: Utility function to send a request to the Audio Manager to remove all
                         tones (EXCEPT the voice tones) from the audio queue and stop any
                         tones that are currently playing.


====================================================================================================
                               Motorola Confidential Proprietary
                           Advanced Technology and Software Operations
                        (c) Copyright Motorola 1999, All Rights Reserved
  

Revision History:
                            Modification     Tracking
Author                          Date          Number     Description of Changes
-------------------------   ------------    ----------   -------------------------------------------
Steve Hagino                 08/03/2000     CSGce67731   Make Audio Manager Ansi-Compliant
Steve Hagino                 03/28/2000     CSGce53043   Implemented aud_stop_all_tones_req()
Chuck Farrell                03/16/2000     CSGce47853   Creation of file   



Portability: This module is portable to other compilers.


====================================================================================================
                                        INCLUDE FILES
==================================================================================================*/

#include <SUAPI/suapi.h>
#include <audio/aud_stop_all_tones_req.h>    
#include <ENGINE_AUDIO/td_aud_voice_req_type.h>
#include <ENGINE_AUDIO/aud_prim_ids.h>
#include <audio/AM_SendMessage.h>

/*==================================================================================================
                                 LOCAL FUNCTION PROTOTYPES
==================================================================================================*/
                                                            
/*==================================================================================================
                                     LOCAL CONSTANTS
==================================================================================================*/

/*==================================================================================================
                          LOCAL TYPEDEFS (STRUCTURES, UNIONS, ENUMS)
==================================================================================================*/

/*==================================================================================================
                                        LOCAL MACROS
==================================================================================================*/

/*==================================================================================================
                                      LOCAL VARIABLES
==================================================================================================*/
                                                            
/*==================================================================================================
                                     GLOBAL VARIABLES
==================================================================================================*/

/*==================================================================================================
                                     LOCAL FUNCTIONS
==================================================================================================*/

/*==================================================================================================
                                       GLOBAL FUNCTIONS
==================================================================================================*/

/*==================================================================================================

FUNCTION: aud_stop_all_tones_req          

DESCRIPTION:
   This functions makes requests of the Audio Manager to remove all tones
   (EXCEPT the voice tones) from the audio queue and stop any tones that
   are currently playing. 

ARGUMENTS PASSED:
   None
    
RETURN VALUE:
   None

PRE-CONDITIONS:
   None
 
POST-CONDITIONS:
   None

IMPORTANT NOTES:
   None
==================================================================================================*/
void 
aud_stop_all_tones_req()
{
    void * msgptr = NULL;
    msgptr =  suCreateMessage((UINT32)0, (UINT32)AUD_STOP_ALL_TONES_REQ_ID, SU_INVALID_HANDLE, NULL);
    AM_SendMessage((char *) msgptr);
}

/*================================================================================================*/