IAudioTrack.h revision 1099586bd48a8a90bb1cc4e7c279703bc7259214 
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 <binder/IInterface.h>
26#include <binder/IMemory.h>
27
28
29namespace android {
30
31// ----------------------------------------------------------------------------
32
33class IAudioTrack : public IInterface
34{
35public:
36    DECLARE_META_INTERFACE(AudioTrack);
37
38    /* Get this track's control block */
39    virtual sp<IMemory> getCblk() const = 0;
40
41    /* After it's created the track is not active. Call start() to
42     * make it active. If set, the callback will start being called.
43     */
44    virtual status_t    start() = 0;
45
46    /* Stop a track. If set, the callback will cease being called and
47     * obtainBuffer will return an error. Buffers that are already released
48     * will be processed, unless flush() is called.
49     */
50    virtual void        stop() = 0;
51
52    /* Flush a stopped track. All pending buffers are discarded.
53     * This function has no effect if the track is not stopped.
54     */
55    virtual void        flush() = 0;
56
57    /* Mute or unmute this track.
58     * While muted, the callback, if set, is still called.
59     */
60    virtual void        mute(bool) = 0;
61
62    /* Pause a track. If set, the callback will cease being called and
63     * obtainBuffer will return an error. Buffers that are already released
64     * will be processed, unless flush() is called.
65     */
66    virtual void        pause() = 0;
67
68    /* Attach track auxiliary output to specified effect. Use effectId = 0
69     * to detach track from effect.
70     */
71    virtual status_t    attachAuxEffect(int effectId) = 0;
72
73};
74
75// ----------------------------------------------------------------------------
76
77class BnAudioTrack : public BnInterface<IAudioTrack>
78{
79public:
80    virtual status_t    onTransact( uint32_t code,
81                                    const Parcel& data,
82                                    Parcel* reply,
83                                    uint32_t flags = 0);
84};
85
86// ----------------------------------------------------------------------------
87
88}; // namespace android
89
90#endif // ANDROID_IAUDIOTRACK_H
91