aboutsummaryrefslogtreecommitdiff
path: root/src/com/android/tv/dvr/DvrDataManager.java
blob: 4f8b05253cc81c36cac06965c87c041fa32187b7 (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
/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * 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.android.tv.dvr;

import android.support.annotation.MainThread;
import android.support.annotation.Nullable;
import android.util.Range;

import java.util.List;

/**
 * Read only data manager.
 */
@MainThread
public interface DvrDataManager {
    long NEXT_START_TIME_NOT_FOUND = -1;

    boolean isInitialized();

    /**
     * Returns recordings.
     */
    List<Recording> getRecordings();

    /**
     * Returns past recordings.
     */
    List<Recording> getFinishedRecordings();

    /**
     * Returns started recordings.
     */
    List<Recording> getStartedRecordings();

    /**
     * Returns scheduled recordings
     */
    List<Recording> getScheduledRecordings();

    /**
     * Returns season recordings.
     */
    List<SeasonRecording> getSeasonRecordings();

    /**
     * Returns the next start time after {@code time} or {@link #NEXT_START_TIME_NOT_FOUND}
     * if none is found.
     *
     * @param time time milliseconds
     */
    long getNextScheduledStartTimeAfter(long time);

    /**
     * Returns a list of all Recordings with a overlap with the given time period inclusive.
     *
     * <p> A recording overlaps with a period when
     * {@code recording.getStartTime() <= period.getUpper() &&
     * recording.getEndTime() >= period.getLower()}.
     *
     * @param period a time period in milliseconds.
     */
    List<Recording> getRecordingsThatOverlapWith(Range<Long> period);

    /**
     * Add a {@link Listener}.
     */
    void addListener(Listener listener);

    /**
     * Remove a {@link Listener}.
     */
    void removeListener(Listener listener);

    /**
     * Returns the recording with the given recordingId or null if is not found
     */
    @Nullable
    Recording getRecording(long recordingId);

    interface Listener {
        void onRecordingAdded(Recording recording);
        void onRecordingRemoved(Recording recording);
        void onRecordingStatusChanged(Recording recording);
    }
}