1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/content/media/TextTrack.h Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,146 @@
1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
1.5 +/* vim:set ts=2 sw=2 et tw=78: */
1.6 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.7 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.8 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.9 +
1.10 +#ifndef mozilla_dom_TextTrack_h
1.11 +#define mozilla_dom_TextTrack_h
1.12 +
1.13 +#include "mozilla/DOMEventTargetHelper.h"
1.14 +#include "mozilla/dom/TextTrackBinding.h"
1.15 +#include "nsCOMPtr.h"
1.16 +#include "nsCycleCollectionParticipant.h"
1.17 +#include "nsString.h"
1.18 +
1.19 +namespace mozilla {
1.20 +namespace dom {
1.21 +
1.22 +class TextTrackList;
1.23 +class TextTrackCue;
1.24 +class TextTrackCueList;
1.25 +class TextTrackRegion;
1.26 +class HTMLTrackElement;
1.27 +
1.28 +enum TextTrackSource {
1.29 + Track,
1.30 + AddTextTrack,
1.31 + MediaResourceSpecific
1.32 +};
1.33 +
1.34 +// Constants for numeric readyState property values.
1.35 +enum TextTrackReadyState {
1.36 + NotLoaded = 0U,
1.37 + Loading = 1U,
1.38 + Loaded = 2U,
1.39 + FailedToLoad = 3U
1.40 +};
1.41 +
1.42 +class TextTrack MOZ_FINAL : public DOMEventTargetHelper
1.43 +{
1.44 +public:
1.45 + NS_DECL_ISUPPORTS_INHERITED
1.46 + NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(TextTrack, DOMEventTargetHelper)
1.47 +
1.48 + TextTrack(nsPIDOMWindow* aOwnerWindow,
1.49 + TextTrackKind aKind,
1.50 + const nsAString& aLabel,
1.51 + const nsAString& aLanguage,
1.52 + TextTrackMode aMode,
1.53 + TextTrackReadyState aReadyState,
1.54 + TextTrackSource aTextTrackSource);
1.55 + TextTrack(nsPIDOMWindow* aOwnerWindow,
1.56 + TextTrackList* aTextTrackList,
1.57 + TextTrackKind aKind,
1.58 + const nsAString& aLabel,
1.59 + const nsAString& aLanguage,
1.60 + TextTrackMode aMode,
1.61 + TextTrackReadyState aReadyState,
1.62 + TextTrackSource aTextTrackSource);
1.63 +
1.64 + void SetDefaultSettings();
1.65 +
1.66 + virtual JSObject* WrapObject(JSContext* aCx) MOZ_OVERRIDE;
1.67 +
1.68 + TextTrackKind Kind() const
1.69 + {
1.70 + return mKind;
1.71 + }
1.72 + void GetLabel(nsAString& aLabel) const
1.73 + {
1.74 + aLabel = mLabel;
1.75 + }
1.76 + void GetLanguage(nsAString& aLanguage) const
1.77 + {
1.78 + aLanguage = mLanguage;
1.79 + }
1.80 + void GetInBandMetadataTrackDispatchType(nsAString& aType) const
1.81 + {
1.82 + aType = mType;
1.83 + }
1.84 + void GetId(nsAString& aId) const;
1.85 +
1.86 + TextTrackMode Mode() const
1.87 + {
1.88 + return mMode;
1.89 + }
1.90 + void SetMode(TextTrackMode aValue);
1.91 +
1.92 + TextTrackCueList* GetCues() const
1.93 + {
1.94 + if (mMode == TextTrackMode::Disabled) {
1.95 + return nullptr;
1.96 + }
1.97 + return mCueList;
1.98 + }
1.99 +
1.100 + TextTrackCueList* GetActiveCues();
1.101 + void UpdateActiveCueList();
1.102 + void GetActiveCueArray(nsTArray<nsRefPtr<TextTrackCue> >& aCues);
1.103 +
1.104 + TextTrackReadyState ReadyState() const;
1.105 + void SetReadyState(TextTrackReadyState aState);
1.106 + void SetReadyState(uint32_t aReadyState);
1.107 +
1.108 + void AddCue(TextTrackCue& aCue);
1.109 + void RemoveCue(TextTrackCue& aCue, ErrorResult& aRv);
1.110 + void SetDirty() { mDirty = true; }
1.111 + void SetCuesDirty();
1.112 +
1.113 + TextTrackList* GetTextTrackList();
1.114 + void SetTextTrackList(TextTrackList* aTextTrackList);
1.115 +
1.116 + IMPL_EVENT_HANDLER(cuechange)
1.117 +
1.118 + HTMLTrackElement* GetTrackElement();
1.119 + void SetTrackElement(HTMLTrackElement* aTrackElement);
1.120 +
1.121 + TextTrackSource GetTextTrackSource() {
1.122 + return mTextTrackSource;
1.123 + }
1.124 +
1.125 +private:
1.126 + nsRefPtr<TextTrackList> mTextTrackList;
1.127 +
1.128 + TextTrackKind mKind;
1.129 + nsString mLabel;
1.130 + nsString mLanguage;
1.131 + nsString mType;
1.132 + TextTrackMode mMode;
1.133 +
1.134 + nsRefPtr<TextTrackCueList> mCueList;
1.135 + nsRefPtr<TextTrackCueList> mActiveCueList;
1.136 + nsRefPtr<HTMLTrackElement> mTrackElement;
1.137 +
1.138 + uint32_t mCuePos;
1.139 + TextTrackReadyState mReadyState;
1.140 + bool mDirty;
1.141 +
1.142 + // An enum that represents where the track was sourced from.
1.143 + TextTrackSource mTextTrackSource;
1.144 +};
1.145 +
1.146 +} // namespace dom
1.147 +} // namespace mozilla
1.148 +
1.149 +#endif // mozilla_dom_TextTrack_h
