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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 et tw=78: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_dom_TextTrack_h
#define mozilla_dom_TextTrack_h
#include "mozilla/DOMEventTargetHelper.h"
#include "mozilla/dom/TextTrackBinding.h"
#include "nsCOMPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsString.h"
#include "TimeUnits.h"
namespace mozilla::dom {
class TextTrackList;
class TextTrackCue;
class TextTrackCueList;
class HTMLTrackElement;
class HTMLMediaElement;
enum class TextTrackSource : uint8_t {
Track,
AddTextTrack,
MediaResourceSpecific,
};
// Constants for numeric readyState property values.
enum class TextTrackReadyState : uint8_t {
NotLoaded = 0U,
Loading = 1U,
Loaded = 2U,
FailedToLoad = 3U
};
class TextTrack final : public DOMEventTargetHelper {
public:
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(TextTrack, DOMEventTargetHelper)
TextTrack(nsPIDOMWindowInner* aOwnerWindow, TextTrackKind aKind,
const nsAString& aLabel, const nsAString& aLanguage,
TextTrackMode aMode, TextTrackReadyState aReadyState,
TextTrackSource aTextTrackSource);
TextTrack(nsPIDOMWindowInner* aOwnerWindow, TextTrackList* aTextTrackList,
TextTrackKind aKind, const nsAString& aLabel,
const nsAString& aLanguage, TextTrackMode aMode,
TextTrackReadyState aReadyState, TextTrackSource aTextTrackSource);
void SetDefaultSettings();
JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
TextTrackKind Kind() const { return mKind; }
void GetLabel(nsAString& aLabel) const;
void GetLanguage(nsAString& aLanguage) const;
void GetInBandMetadataTrackDispatchType(nsAString& aType) const {
aType = mType;
}
void GetId(nsAString& aId) const;
TextTrackMode Mode() const { return mMode; }
void SetMode(TextTrackMode aValue);
TextTrackCueList* GetCues() const {
if (mMode == TextTrackMode::Disabled) {
return nullptr;
}
return mCueList;
}
TextTrackCueList* GetActiveCues();
void GetActiveCueArray(nsTArray<RefPtr<TextTrackCue> >& aCues);
TextTrackReadyState ReadyState() const;
void SetReadyState(TextTrackReadyState aState);
void AddCue(TextTrackCue& aCue);
void RemoveCue(TextTrackCue& aCue, ErrorResult& aRv);
void SetDirty() { mDirty = true; }
void SetCuesDirty();
TextTrackList* GetTextTrackList();
void SetTextTrackList(TextTrackList* aTextTrackList);
IMPL_EVENT_HANDLER(cuechange)
HTMLTrackElement* GetTrackElement();
void SetTrackElement(HTMLTrackElement* aTrackElement);
TextTrackSource GetTextTrackSource() { return mTextTrackSource; }
void SetCuesInactive();
void NotifyCueUpdated(TextTrackCue* aCue);
void DispatchAsyncTrustedEvent(const nsString& aEventName);
bool IsLoaded();
// Called when associated cue's active flag has been changed, and then we
// would add or remove the cue to the active cue list.
void NotifyCueActiveStateChanged(TextTrackCue* aCue);
// Use this function to request current cues, which start time are less than
// or equal to the current playback position and whose end times are greater
// than the current playback position, and other cues, which are not in the
// current cues. Because there would be LOTS of cues in the other cues, and we
// don't actually need all of them. Therefore, we use a time interval to get
// the cues which are overlapping within the time interval.
void GetCurrentCuesAndOtherCues(RefPtr<TextTrackCueList>& aCurrentCues,
RefPtr<TextTrackCueList>& aOtherCues,
const media::TimeInterval& aInterval) const;
void ClearAllCues();
private:
~TextTrack();
HTMLMediaElement* GetMediaElement() const;
RefPtr<TextTrackList> mTextTrackList;
TextTrackKind mKind;
nsString mLabel;
nsString mLanguage;
nsString mType;
TextTrackMode mMode;
RefPtr<TextTrackCueList> mCueList;
RefPtr<TextTrackCueList> mActiveCueList;
RefPtr<HTMLTrackElement> mTrackElement;
uint32_t mCuePos;
TextTrackReadyState mReadyState;
bool mDirty;
// An enum that represents where the track was sourced from.
TextTrackSource mTextTrackSource;
};
} // namespace mozilla::dom
#endif // mozilla_dom_TextTrack_h
|
