text_track.h

Go to the documentation of this file.

// Copyright 2019 Google LLC
//
// 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
//
//     https://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.

#ifndef SHAKA_EMBEDDED_MEDIA_TEXT_TRACK_H_
#define SHAKA_EMBEDDED_MEDIA_TEXT_TRACK_H_

#include <memory>
#include <string>
#include <vector>

#include "../macros.h"
#include "vtt_cue.h"

namespace shaka {
namespace media {

enum class TextTrackKind : uint8_t {
  Subtitles,

  Captions,

  Descriptions,

  Chapters,

  Metadata,
};

enum class TextTrackMode : uint8_t {
  Disabled,

  Hidden,

  Showing,
};

class SHAKA_EXPORT TextTrack {
 public:
  class Client {
   public:
    SHAKA_DECLARE_INTERFACE_METHODS(Client);

    virtual void OnCueAdded(std::shared_ptr<VTTCue> cue) = 0;

    virtual void OnCueRemoved(std::shared_ptr<VTTCue> cue) = 0;
  };

  TextTrack(TextTrackKind kind, const std::string& label,
            const std::string& language, const std::string& id);
  virtual ~TextTrack();

  SHAKA_NON_COPYABLE_OR_MOVABLE_TYPE(TextTrack);

  const TextTrackKind kind;

  const std::string label;

  const std::string language;

  const std::string id;


  virtual TextTrackMode mode() const;

  virtual void SetMode(TextTrackMode mode);


  virtual std::vector<std::shared_ptr<VTTCue>> cues() const;

  virtual std::vector<std::shared_ptr<VTTCue>> active_cues(double time) const;

  double NextCueChangeTime(double time) const;

  virtual void AddCue(std::shared_ptr<VTTCue> cue);

  virtual void RemoveCue(std::shared_ptr<VTTCue> cue);


  void AddClient(Client* client);

  void RemoveClient(Client* client);

 private:
  class Impl;
  std::unique_ptr<Impl> impl_;
};

}  // namespace media
}  // namespace shaka

#endif  // SHAKA_EMBEDDED_MEDIA_TEXT_TRACK_H_