2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #ifndef __TIZEN_MEDIA_TONE_PLAYER_DOC_H__
19 #define __TIZEN_MEDIA_TONE_PLAYER_DOC_H__
23 * @file tone_player_doc.h
24 * @brief This file contains high level documentation for the Tone Player API.
29 * @ingroup CAPI_MEDIA_FRAMEWORK
30 * @defgroup CAPI_MEDIA_TONE_PLAYER_MODULE Tone Player
34 * @ingroup CAPI_MEDIA_FRAMEWORK
35 * @addtogroup CAPI_MEDIA_TONE_PLAYER_MODULE
36 * @brief The @ref CAPI_MEDIA_TONE_PLAYER_MODULE API provides functions for playing the tone.
37 * @section CAPI_MEDIA_TONE_PLAYER_MODULE_HEADER Required Header
38 * \#include <tone_player.h>
40 * @section CAPI_MEDIA_TONE_PLAYER_OVERVIEW Overview
41 * The @ref CAPI_MEDIA_TONE_PLAYER_MODULE API allows you to play and stop playing the tone. To play a particular type of tone(#tone_type_e), use tone_player_start(). To stop playing the tone, call tone_player_stop().
44 #endif /* __TIZEN_MEDIA_TONE_PLAYER_DOC_H__ */