am_vr_playback_record.h

Motorola synergy audio component

#ifndef AM_VR_PLAYBACK_RECORD_CLASS_INCLUDE
#define AM_VR_PLAYBACK_RECORD_CLASS_INCLUDE

/* (c) Copyright Motorola 1997, All rights reserved.        
   Motorola Confidential Proprietary
   Contains confidential proprietary information of Motorola, Inc.
   Reverse engineering is prohibited.
   The copyright notice does not imply publication.
  
   DESCRIPTION: 
       This file defines the AM_VR_Playback_Record class.
 
 ************** REVISION HISTORY **********************************************
  
   Date       Author      Reference
   ========   ========    ==========================
   98-11-04   blamers     CR - CSGce23508
              Whitecap VR Event Handler Changes
              - Rid AM of compiler warning.

   97-05-28   slam        PR - CSGce10240
*/
/************** HEADER FILE INCLUDES ******************************************/
#include <stddef.h>
#ifndef SUAPI_INCLUDE
#include <SUAPI/suapi.h>
#endif
#include "am_sdvr_records.h"
#include <ENGINE_AUDIO/td_vr_defs.h>
#include <ENGINE_AUDIO/td_vr_group_types.h>
#include <ENGINE_AUDIO/td_vr_voice_tag.h>

/************** CONSTANTS *****************************************************/

/************** STRUCTURES, ENUMS, AND TYPEDEFS *******************************/

/************** FUNCTION PROTOTYPES *******************************************/

/************** MACROS ********************************************************/

/************** CLASS DEFINITIONS *********************************************/
class AM_VR_Playback_Record
{
public:

    /*
     * Overload the new and delete operators to prevent calls to the 
     * system's new and delete functions.
     */ 
    inline void * operator new(size_t) { return(NULL); }
    inline void operator delete(void *, size_t) {}

    /*
     * class constructor
     */
    AM_VR_Playback_Record 
    ( AM_VR_PLAYBACK_RECORD *playback_record_ptr );

    /* 
     * class destructor, do nothing, but prevents allocation of __Ptbl in 
     * everyfile that includes this .H file.
     */
    ~AM_VR_Playback_Record (void) {};
    
    /*
     * clear voice tag record
     */
    void
    clear ( void );

    /*
     * save voice tag data
     */
    void
    save 
    (
     /* voice tag count */
     UINT16 voice_tag_count,

     /* voice tag array */
     TD_VR_VOICE_TAG *voice_tag_array
     );

    /*
     * return the number of voice tags in the voice tag playback record
     */
    inline UINT16 get_voice_tag_count ( void )
	{
		return( voice_tag_ptr->voice_tag_count );
	}

    /*
     * return pointer to the voice tag array 
     */
    inline TD_VR_VOICE_TAG *get_voice_tag_array ( void )
	{
		return( voice_tag_ptr->voice_tag_array );
	}


private:

   AM_VR_PLAYBACK_RECORD *voice_tag_ptr;
};

#endif //end of AM_VR_PLAYBACK_RECORD_CLASS_INCLUDE