IAudioTrack.h revision 89fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5 
1/*
2 * Copyright (C) 2007 The Android Open Source Project
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#ifndef ANDROID_IAUDIOTRACK_H
18#define ANDROID_IAUDIOTRACK_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <utils/RefBase.h>
24#include <utils/Errors.h>
25#include <utils/IInterface.h>
26#include <utils/IMemory.h>
27
28
29namespace android {
30
31// ----------------------------------------------------------------------------
32
33class IAudioTrack : public IInterface
34{
35public:
36    DECLARE_META_INTERFACE(AudioTrack);
37
38    /* After it's created the track is not active. Call start() to
39     * make it active. If set, the callback will start being called.
40     */
41    virtual status_t    start() = 0;
42
43    /* Stop a track. If set, the callback will cease being called and
44     * obtainBuffer will return an error. Buffers that are already released
45     * will be processed, unless flush() is called.
46     */
47    virtual void        stop() = 0;
48
49    /* flush a stopped track. All pending buffers are discarded.
50     * This function has no effect if the track is not stoped.
51     */
52    virtual void        flush() = 0;
53
54    /* mute or unmutes this track.
55     * While mutted, the callback, if set, is still called.
56     */
57    virtual void        mute(bool) = 0;
58
59    /* Pause a track. If set, the callback will cease being called and
60     * obtainBuffer will return an error. Buffers that are already released
61     * will be processed, unless flush() is called.
62     */
63    virtual void        pause() = 0;
64
65    /* get this tracks control block */
66    virtual sp<IMemory> getCblk() const = 0;
67};
68
69// ----------------------------------------------------------------------------
70
71class BnAudioTrack : public BnInterface<IAudioTrack>
72{
73public:
74    virtual status_t    onTransact( uint32_t code,
75                                    const Parcel& data,
76                                    Parcel* reply,
77                                    uint32_t flags = 0);
78};
79
80// ----------------------------------------------------------------------------
81
82}; // namespace android
83
84#endif // ANDROID_IAUDIOTRACK_H
85