doc/wave_player_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_MEDIA_WAV_PLAYER_DOC_H__
  19 #define __TIZEN_MEDIA_WAV_PLAYER_DOC_H__
  20
  21
  22 /**
  23  * @file wave_player_doc.h
  24  * @brief This file contains high level documentation for the WAV Player API.
  25  *
  26  */
  27
  28 /**
  29  * @ingroup CAPI_MEDIA_FRAMEWORK
  30  * @defgroup CAPI_MEDIA_WAV_PLAYER_MODULE WAV Player
  31  */
  32
  33 /**
  34  * @ingroup CAPI_MEDIA_FRAMEWORK
  35  * @addtogroup CAPI_MEDIA_WAV_PLAYER_MODULE
  36  * @brief The @ref CAPI_MEDIA_WAV_PLAYER_MODULE API provides functions for playing the waveform audio file format(*.wav).
  37   * @section CAPI_MEDIA_WAV_PLAYER_MODULE_HEADER Required Header
  38  *    \#include <wav_player.h>
  39  *
  40  * @section CAPI_MEDIA_WAV_PLAYER_OVERVIEW Overview
  41  * The @ref CAPI_MEDIA_WAV_PLAYER_MODULE API allows you to simply play and stop a wav file. To play a certain wav file, call wave_player_start() with a path to the .wav file.
  42  * When playing a wav file is finished, wav_player_playback_completed_cb() will be invoked.
  43  */
  44
  45 #endif /* __TIZEN_MEDIA_WAV_PLAYER_DOC_H__ */
  46
  47