aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/com/google/android/mobly/snippet/bundled/AudioSnippet.java
blob: 9b4874f98996ae220af867c894c9f8eda0b3b6db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
 * Copyright (C) 2017 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.android.mobly.snippet.bundled;

import android.content.Context;
import android.media.AudioManager;
import androidx.test.platform.app.InstrumentationRegistry;
import com.google.android.mobly.snippet.Snippet;
import com.google.android.mobly.snippet.rpc.Rpc;
import java.lang.reflect.Method;

/* Snippet class to control audio */
public class AudioSnippet implements Snippet {

    private final AudioManager mAudioManager;

    public AudioSnippet() {
        Context context = InstrumentationRegistry.getInstrumentation().getContext();
        mAudioManager = (AudioManager) context.getSystemService(Context.AUDIO_SERVICE);
    }

    @Rpc(description = "Sets the microphone mute state: True = Muted, False = not muted.")
    public void setMicrophoneMute(boolean state) {
        mAudioManager.setMicrophoneMute(state);
    }

    @Rpc(description = "Returns whether or not the microphone is muted.")
    public boolean isMicrophoneMute() {
        return mAudioManager.isMicrophoneMute();
    }

    @Rpc(description = "Returns whether or not any music is active.")
    public boolean isMusicActive() {
        return mAudioManager.isMusicActive();
    }

    @Rpc(description = "Gets the music stream volume.")
    public Integer getMusicVolume() {
        return mAudioManager.getStreamVolume(AudioManager.STREAM_MUSIC);
    }

    @Rpc(description = "Gets the maximum music stream volume value.")
    public int getMusicMaxVolume() {
        return mAudioManager.getStreamMaxVolume(AudioManager.STREAM_MUSIC);
    }

    @Rpc(
            description =
                    "Sets the music stream volume. The minimum value is 0. Use 'getMusicMaxVolume'"
                            + " to determine the maximum.")
    public void setMusicVolume(Integer value) {
        mAudioManager.setStreamVolume(
                AudioManager.STREAM_MUSIC, value, 0 /* flags, 0 = no flags */);
    }

    @Rpc(description = "Gets the ringer volume.")
    public Integer getRingVolume() {
        return mAudioManager.getStreamVolume(AudioManager.STREAM_RING);
    }

    @Rpc(description = "Gets the maximum ringer volume value.")
    public int getRingMaxVolume() {
        return mAudioManager.getStreamMaxVolume(AudioManager.STREAM_RING);
    }

    @Rpc(
            description =
                    "Sets the ringer stream volume. The minimum value is 0. Use 'getRingMaxVolume'"
                            + " to determine the maximum.")
    public void setRingVolume(Integer value) {
        mAudioManager.setStreamVolume(AudioManager.STREAM_RING, value, 0 /* flags, 0 = no flags */);
    }

    @Rpc(description = "Gets the voice call volume.")
    public Integer getVoiceCallVolume() {
        return mAudioManager.getStreamVolume(AudioManager.STREAM_VOICE_CALL);
    }

    @Rpc(description = "Gets the maximum voice call volume value.")
    public int getVoiceCallMaxVolume() {
        return mAudioManager.getStreamMaxVolume(AudioManager.STREAM_VOICE_CALL);
    }

    @Rpc(
            description =
                    "Sets the voice call stream volume. The minimum value is 0. Use"
                            + " 'getVoiceCallMaxVolume' to determine the maximum.")
    public void setVoiceCallVolume(Integer value) {
        mAudioManager.setStreamVolume(
                AudioManager.STREAM_VOICE_CALL, value, 0 /* flags, 0 = no flags */);
    }

    @Rpc(description = "Silences all audio streams.")
    public void muteAll() throws Exception {
        /* Get numStreams from AudioSystem through reflection. If for some reason this fails,
         * calling muteAll will throw. */
        Class<?> audioSystem = Class.forName("android.media.AudioSystem");
        Method getNumStreamTypes = audioSystem.getDeclaredMethod("getNumStreamTypes");
        int numStreams = (int) getNumStreamTypes.invoke(null /* instance */);
        for (int i = 0; i < numStreams; i++) {
            mAudioManager.setStreamVolume(i /* audio stream */, 0 /* value */, 0 /* flags */);
        }
    }

    @Rpc(
            description =
                    "Puts the ringer volume at the lowest setting, but does not set it to "
                            + "DO NOT DISTURB; the phone will vibrate when receiving a call.")
    public void muteRing() {
        setRingVolume(0);
    }

    @Rpc(description = "Mute music stream.")
    public void muteMusic() {
        setMusicVolume(0);
    }

    @Override
    public void shutdown() {}
}